CCeDBRecord::DeleteProp

This method deletes a property from the record.

At a Glance

Header file: Wcedb.h
Platforms: H/PC 2.0, Palm-size PC, H/PC Pro
Windows CE versions: 2.0 and later

Syntax

void DeleteProp( WORD wPropIdent );

Parameters

wPropIdent
Application-defined identifier of the property to delete.

Return Values

None.

Remarks

DeleteProp releases the pointer to a property stored in the CCeDBRecord object's internal list, and frees its member strings and CEBLOB structure. The record's internal list only contains pointers to properties that were created by calling ReadCurrRecord. If the property specified was added using either the AddProp or AddProps method, DeleteProp does not free its memory.

In a Windows CE object store database, you can delete a property on which a sort order has been defined without any adverse effects. By default, when a database is opened with an active sort property, records that do not contain the corresponding property are placed last in the sort order. If the sort property was defined in CCeDBDatabase::Create or CCeDBDatabase::SetSortProps with the flag Sort_UnknownFirst, they are placed first.

See Also

CCeDBProp, CCeDBDatabase::Create, CCeDBRecord::DeleteAllProps, CCeDBDatabase::SetSortProps