CeSetDatabaseInfo (RAPI) (Windows CE 5.0)
This function sets various database parameters, including the name, type, and sort-order descriptions.
CeSetDatabaseInfo 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.
BOOLCeSetDatabaseInfo(CEOIDoidDbase, CEDBASEINFO* pNewInfo);
Parameters
- 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 within a RAPI program, call CeGetLastError. Possible values for CeGetLastError include the following.
| Value | Description |
|---|---|
| ERROR_INVALID_PARAMETER | A parameter was invalid. |
| ERROR_DISK_FULL | The object store is full and any size changes required could not be accommodated. Changing sort orders can change the size of the stored records, though not by much. |
| ERROR_SHARING_VIOLATION | CeSetDatabaseInfo (RAPI) tried to remove a sort order that is being used by a currently open database. |
Remarks
The CeSetDatabaseInfo (RAPI) function can be used to change the database parameters passed in while creating the database. Note that changing the sort order of the database can take several minutes. Before calling CeSetDatabaseInfo (RAPI), an application should warn the user that this operation can be lengthy.
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.
For Windows CE versions 2.10 through 2.12, do not call this function on an open database. For Windows CE versions 3.0 and later, the sort orders of a database cannot be changed while a handle to that database remains open.
Requirements
OS Versions: Windows CE 1.01 and later.
Header: Rapi.h.
Link Library: Rapi.lib.
See Also
RAPI Functions | CeCreateDatabase (RAPI) | CeGetLastError | CeOidGetInfo (RAPI) | CEDBASEINFO
Send Feedback on this topic to the authors