CeRemoveDatabaseProps (EDB) (Windows CE 5.0)
This function is used to remove properties from a database.
This function does not work with CEDB databases. For more information about CEDB, see CEDB Reference.
BOOL CeRemoveDatabaseProps(PCEGUIDpGuid,CEOIDoidDb,DWORDcProps,CEPROPID*prgProps);
Parameters
- pGuid
[in] The CEGUID of the mounted volume in which the database identified by the oidDb parameter resides. You can mount a volume by using the CeMountDbVolEx (EDB) function. - oidDb
[in] The OID of the database from which to remove the property IDs. This database must exist in the volume specified by the pGuid parameter. This OID must have been generated by the CeCreateDatabaseWithProps (EDB) function. - cProps
[in] The number of property IDs in the prgProps array. - prgProps
[in] The array of property IDs to remove from the database.
Return Values
TRUE indicates success. FALSE indicates failure. To get extended error information, call GetLastError. The following table lists possible values returned by GetLastError:
Return Value | Description |
---|---|
ERROR_INVALID_PARAMETER | Indicates one of the following:
|
ERROR_NOT_FOUND | Indicates one of the following:
|
ERROR_ACCESS_DENIED | Indicates that the property is part of an active sort order. |
ERROR_SHARING_VIOLATION | Indicates that another thread currently has the database open. |
Remarks
At some point, a client may decide that there are properties in a database that are no longer used. When this occurs, the client can use this function to remove those properties and clean up the database, potentially resulting in a volume size reduction.
This function succeeds only if the database is not open and the property is not part of an active sort order.
Properties are added to a database by using the CeAddDatabaseProps (EDB) function.
Requirements
OS Versions: Windows CE 5.0 and later.
Header: Windbase.h.
Link Library: Coredll.lib.
See Also
CeMountDbVolEx (EDB) | CeCreateDatabaseWithProps (EDB) | CEPROPSPEC (EDB) | CeAddDatabaseProps (EDB) | EDB Schema Support
Send Feedback on this topic to the authors