This function sets various database parameters, including the name, type, and sort-order descriptions. This function is obsolete. Applications should call CeSetDataBaseInfoEx instead.
A remote application interface (RAPI) version of this function exists, and it is also called CeSetDatabaseInfo.
At a Glance
| Header file: | Winbase.h |
| Windows CE versions: | 1.01 and later |
Syntax
BOOL CeSetDatabaseInfo(CEOID oidDbase, 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 Windows CE program, call GetLastError. Possible values for GetLastError include the following:
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 tried to remove a sort order that is being used by a currently open database.
Remarks
The CeSetDatabaseInfo 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, an application should warn the user that this operation can be lengthy.
See Also