CeWriteRecordProps (RAPI) (Windows CE 5.0)
This function writes a set of properties to a single record, creating the record if necessary.
CeWriteRecordProps 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.
CEOIDCeWriteRecordProps(HANDLEhDbase, CEOIDoidRecord, WORDcPropID, CEPROPVAL* rgPropVal);
Parameters
- hDbase
[in] Handle to an open database. The database must have been opened by a previous call to the CeOpenDatabase (RAPI) function. - oidRecord
[in] Object identifier of the record to which the specified properties are to be written. If this parameter is 0, a new record is created and filled in with the specified properties. - cPropID
[in] Number of properties in the array specified by the rgPropVal parameter. The cPropID parameter must not be 0. - rgPropVal
[in] Pointer to an array of CEPROPVAL structures that specify the property values to be written to the specified record.
Return Values
The object identifier of the record to which the properties were written indicates success. Zero indicates failure. To get extended error information within a RAPI program, call CeGetLastError. CeGetLastError may return one of the following values.
| Value | Description |
|---|---|
| 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 (RAPI) function writes all the requested properties into the specified record. CeWriteRecordProps (RAPI) 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 marshaled in like the array returned by CeReadRecordProps (RAPI), or they can be independently allocated.
For Windows CE 2.10 and later, on a mounted database volume, all write operations are cached. The database subsystem periodically requests a cache flush after a series of operations. If memory is low, the cache is flushed to permanent storage. Unlike a file system that can choose to flush only part of the cache, on a database, all blocks are flushed.
Note Earlier versions of Windows CE assigned object identifiers to objects in other file systems, such as the file allocation table (FAT) file system. These object identifiers were guaranteed to be unique within a volume, but not across multiple volumes. Effective with version 3.0, only objects in the object store have valid, unique object identifiers and the object store is the only volume that can return an object identifier.
Requirements
OS Versions: Windows CE 1.01 and later.
Header: Rapi.h.
Link Library: Rapi.lib.
See Also
RAPI Functions | CeGetLastError | CeOpenDatabase (RAPI) | CeReadRecordProps (RAPI) | CEPROPVAL
Send Feedback on this topic to the authors