Share via

CEDBASEINFO

  • Article

This structure contains information about a database object. This structure is used by the CeSetDatabaseInfoEx2 and CeCreateDatabaseEx2 functions.

typedef struct _CEDBASEINFO {
  DWORD dwFlags; 
  WCHAR szDbaseName[CEDB_MAXDBASENAMELEN];
  DWORD dwDbaseType;
  WORD wNumRecords;
  WORD wNumSortOrder;
  DWORD dwSize;
  FILETIME ftLastModified;
  SORTORDERSPEC rgSortSpecs[CEDB_MAXSORTORDER];
} CEDBASEINFO;

Members

  • dwFlags
    This member may be set to one or a combination of possible values. The following table shows the possible values for dwFlags.
    Flag Description
    CEDB_VALIDMODTIME Indicates that the ftLastModified member is valid and should be used.
    CEDB_VALIDNAME Indicates that the szDbaseName member is valid and should be used.
    CEDB_VALIDTYPE Indicates that the dwDbaseType member is valid and should be used.
    CEDB_VALIDSORTSPEC Indicates that the rgSortSpecs member is valid and should be used.
    CEDB_VALIDDBFLAGS Sets the compression state of the database.
    CEDB_NOCOMPRESS Indicates that the database is not compressed. If this flag is used with CeSetDatabaseInfoEx, new or modified records in a compressed database are uncompressed. If this flag is used with CeCreateDatabaseEx, the database is not compressed.

    By default, all databases are compressed. If you are going to change the compression, it should be done at creation time.
    CEDB_SYSTEMDB Indicates that the database is marked as a system database and cannot be deleted by an untrusted application. An untrusted application cannot make the following API calls on a system database file:

    CeCreateDatabaseEx, CeSetDatabaseInfoEx, or CeDeleteDatabase.
  • szDbaseName
    Null-terminated string that contains the name of the database. The string can have up to 32 characters, including the terminating null character. This member must be set when used for CeCreateDatabaseEx.
  • dwDbaseType
    Type identifier for the database.
  • wNumRecords
    Number of records in the database.
  • wNumSortOrder
    Number of sort orders active in the database. Up to four sort orders can be active at a time.
  • dwSize
    Size of the database in bytes.
  • ftLastModified
    Last time this database was modified.
  • rgSortSpecs
    Array containing the sort order descriptions. Only the first n array members are valid, where n is the value specified by the wNumSortOrder member. If no sort orders are specified for CeCreateDatabaseEx or when CEDB_VALIDSORTSPEC is not specified, then a default sort order is assigned to the database.

Remarks

For Windows CE versions 2.10 and later, dwFlags has additional meaning, but is still compatible with previous versions. The high-order word of dwFlags specifies additional database properties.

CeSetDatabaseInfoEx2 and CeOidGetInfoEx2 can use all of the dwFlags flags. CeCreateDatabaseEx2 only makes use of the CEDB_VALIDDBFLAGS, CEDB_NOCOMPRESS, and CEDB_SYSTEMDB flags. Using other flags with CeCreateDatabaseEx2 will be ignored.

Requirements

OS Versions: Windows CE 1.01 and later.
Header: Windbase.h.

See Also

CeSetDatabaseInfoEx2 | CeSetDatabaseInfoEx2 | HIWORD | LOWORD | CEOIDINFO | CeOidGetInfoEx2

 Last updated on Friday, April 09, 2004

© 1992-2003 Microsoft Corporation. All rights reserved.