CeWriteRecordProps

The CeWriteRecordProps function writes a set of properties to a single record, creating the record if necessary. A RAPI version of this function exists and is also called CeWriteRecordProps.

Syntax

CEOID CeWriteRecordProps(HANDLE hDbase, CEOID oidRecord, WORD cPropID, CEPROPVAL * rgPropVal);

At a Glance

Parameters

hDbase

Handle to an open database. The database must have been opened by a previous call to the CeOpenDatabase function.

oidRecord

Object identifier of the record to which the given properties are to be written. If this parameter is zero, a new record is created and filled in with the given properties.

cPropID

Number of properties in the array specified by the rgPropVal parameter. The cPropID parameter must not be zero.

rgPropVal

Pointer to an array of CEPROPVAL structures that specify the property values to be written to the given record.

Return Values

If the function succeeds, the return value is the object identifier of the record to which the properties were written. If the function fails, the return value is zero. To get extended error information when within a CE program call GetLastError. If within a RAPI program, call CeGetLastError. GetLastError and CeGetLastError may return one of the following values:

ERROR_DISK_FULL

There was not enough space in the object store to write the properties.

ERROR_INVALID_PARAMETER

A parameter was invalid.

Remarks

The CeWriteRecordProps function writes all the requested properties into the specified record. CeWriteRecordProps does not move the seek pointer.

To delete a property, set the CEDB_PROPDELETE flag in the appropriate property value. This allows multiple deletes and changes in a single call, which is much more efficient than multiple calls.

No memory is freed by the callee. Pointers in the CEPROPVAL structures can be anywhere in the caller's address space—they can be marshalled in like the array returned by CeReadRecordProps, or they can be independently allocated.

For more information, see Accessing Persistent Storage.

When writing applications for Windows CE version 1.0, use the PegWriteRecordProps function.