CeSetDatabaseInfoEx2 (CEDB)
Other versions of this page are also available for the following:
.gif "A hyphen indicates that the information in this topic is not relevant for this platform, or that the platform does not support the API that is listed.")
.gif "A checkmark indicates that the information in this topic is relevant for this platform, and that any API listed is also supported on this platform.")
8/28/2008
This function sets database parameters, including the name, type, sort-order descriptions, and compression of the database.
This function does not work with EDB databases. For more information, see EDB Functions.
Syntax
BOOL CeSetDatabaseInfoEx2(
PCEGUID pguid,
CEOID oidDbase,
CEDBASEINFOEX* pNewInfo
);
Parameters
- pguid
[in] Pointer to the CEGUID that contains the globally unique identifier (GUID) of a mounted database volume or of the object store. Use the CREATE_SYSTEMGUID macro to obtain the GUID of the object store.
- oidDbase
[in] Object identifier of the database for which parameters are to be set.
- pNewInfo
[in] Pointer to a CEDBASEINFOEX (CEDB) structure that contains new parameter information for the database. The wNumRecords member of the structure is not used.
Return Value
TRUE indicates success. FALSE indicates failure. To get extended error information, call GetLastError. The following table lists possible values.
| Value | Description |
|---|---|
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 this function tried to remove a sort order that is being used by a currently open database. For Windows CE 3.0 and later, indicates that this function was called on an open database. |
Remarks
The sort orders of a database cannot be changed while a handle to that database remains open.
Use this function 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 retains its original information. An ERROR_ACCESS_DENIED error returns if a non-NULL requirement is 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, 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.
If you attempt to change the information for an existing database and pass the CEDB_VALIDNAME flag in the dwFlags member of the CEDBASEINFOEX (CEDB) structure, you receive an error stating that there is an existing database with that name. If you do not want to change the database name, do not set the CEDB_VALIDNAME flag. Only the flags for the parameters that are changing should be set. For parameters that are not changing, do not set the corresponding CEDB_VALID* flag.
Requirements
| Header | windbase.h |
| Library | coredll.lib |
| Windows Embedded CE | Windows CE .NET 4.0 and later |
See Also
Reference
CEDB Functions
CeCreateDatabaseEx2 (CEDB)
CEDBASEINFOEX (CEDB)
CeOidGetInfoEx2 (CEDB)
CREATE_SYSTEMGUID