CeSetDatabaseInfoEx (RAPI) (Windows CE 5.0)
This function sets various database parameters, including the name, type, sort-order descriptions, and compression of the database.
CeSetDatabaseInfoEx is a remote application interface (RAPI), which enables an application running on a desktop computer to make function calls on a Windows CE–based device.
BOOL CeSetDatabaseInfoEx( PCEGUID pceguid,CEOID oidDbase,CEDBASEINFO* pNewInfo);
Parameters
- pceguid
[in] Pointer to the CEGUID that contains the globally unique identifier of a mounted database. - oidDbase
[in] Object identifier of the database for which parameters are to be set. - pNewInfo
[in] Pointer to a CEDBASEINFO structure that contains new parameter information for the database. The wNumRecords member of the structure is not used.
Return Values
TRUE indicates success. FALSE indicates failure. To get extended error information, call CeGetLastError. Possible values for CeGetLastError include the following.
| Value | Description |
|---|---|
| ERROR_INVALID_PARAMETER | A parameter was invalid. |
| ERROR_DISK_FULL | 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 | The CeSetDatabaseInfoEx function tried to remove a sort order that is being used by a currently open database. |
Remarks
Use CeSetDatabaseInfoEx to change the database parameters passed in while creating the database. 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.
If you attempt to change the information for an existing database and pass the CEDB_VALIDNAME flag in the dwFlags member of the CEDBASEINFO structure, you will receive an error stating that there is an existing database with that name. If you do not want to change the database name, you should not set the CEDB_VALIDNAME flag. Only the flags for the parameters that are changing should be set. For parameters that are not changing, you should not set the corresponding CEDB_VALID* flag.
Requirements
OS Versions: Windows CE 2.10 and later.
Header: Rapi.h.
Link Library: Rapi.lib.
See Also
RAPI Functions | CeCreateDatabaseEx | CeOidGetInfoEx | CeGetLastError | CEDBASEINFO | CREATE_SYSTEMGUID
Send Feedback on this topic to the authors