CEDBASEINFO

This structure contains information about a database object. This structure is used by the CeSetDatabaseInfo and CeCreateDatabaseEx 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;

Parameters

  • dwFlags
    This member is one or a combination of the following flags:

    Value Description
    CEDB_VALIDMODTIME The ftLastModified member is valid and should be used.
    CEDB_VALIDNAME The szDbaseName member is valid and should be used.
    CEDB_VALIDTYPE The dwDbaseType member is valid and should be used.
    CEDB_VALIDSORTSPEC The rgSortSpecs member is valid and should be used.
    CEDB_VALIDDBFLAGS This flag should be used in combination with the following flag to set the compression state of the database.
    CEDB_NOCOMPRESS 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.

  • 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
    Specifies the type identifier for the database.

  • wNumRecords
    Returns the 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
    Specifies, in bytes, the size of the database.

  • ftLastModified
    Returns the 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.

Requirements

Runs on Versions Defined in Include Link to
Windows CE OS 1.01 and later Windbase.h Winbase.h  

Note   This API is part of the complete Windows CE OS package as provided by Microsoft. The functionality of a particular platform is determined by the original equipment manufacturer (OEM) and some devices may not support this API.

See Also

CeCreateDatabaseEx, CeSetDatabaseInfo, CeSetDatabaseInfoEx, HIWORD, LOWORD, CEOIDINFO

 Last updated on Tuesday, July 13, 2004

© 1992-2000 Microsoft Corporation. All rights reserved.