This function sets various database parameters, including the name, type, sort-order descriptions, and compression of the database.
BOOL CeSetDatabaseInfoEx2( PCEGUID pguid, CEOID oidDbase, CEDBASEINFOEX* pNewInfo );
- [in] Pointer to the CEGUID that contains the globally unique identifier of a mounted database volume, or of the object store. Use CREATE_SYSTEMGUID to obtain the GUID of the object store.
- [in] Object identifier of the database for which parameters are to be set.
- [in] Pointer to a CEDBASEINFOEX structure that contains new parameter information for the database. The wNumRecords member of the structure is not used.
TRUE indicates success. FALSE indicates failure. To get extended error information, call GetLastError. The following table lists possible values for GetLastError.
|ERROR_INVALID_PARAMETER||Indicates that a parameter was invalid.|
|ERROR_DISK_FULL||Indicates that the object store or mounted volume is full and any size changes required could not be accommodated. Changing sort orders can minimally change the size of the stored records.|
|ERROR_SHARING_VIOLATION||Indicates that the CeSetDatabaseInfoEx function tried to remove a sort order that is being used by a currently open database. For Windows CE versions 3.0 and later, indicates that CeSetDatabaseInfoEx was called on an open database.|
The sort orders of a database cannot be changed while a handle to that database remains open.
Use CeSetDatabaseInfoEx2 to change the database parameters passed in while creating the database.
If you try to change the database sort order to sort on non-NULL properties or unique keys, the change may fail because existing records do not satisfy those new requirements. The database will retain its original information. An ERROR_ACCESS_DENIED error will return if a non-NULL requirement was not satisfied and an ERROR_ALREADY_EXISTS error if a non-unique keys exist. Processing a failure caused by an ERROR_ALREADY_EXISTS is potentially very slow and should be avoided.
If the database key is constrained to be unique, then all records are required to have all of the sort properties. The addition of a unique constraint adds non-NULL requirements for all of the sort properties. Changing the sort order or compression of a database is a very expensive operation, possibly taking a few minutes. Before calling this function, warn the user that this is a lengthy process.
Changing the compression of a database affects only new and modified records.
OS Versions: Windows CE .NET 4.0 and later.
Link Library: Coredll.lib.
Last updated on Friday, April 09, 2004
© 1992-2003 Microsoft Corporation. All rights reserved.