CeReadRecordPropsEx

Important:
This is retired content. This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This content may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist.

This function reads properties from the current record. A remote application interface (RAPI) version of this function exists, and it is also called CeReadRecordPropsEx.

CEOID CeReadRecordPropsEx (
HANDLE
hDbase
,

DWORD
dwFlags
,
LPWORD
lpcPropID
,

CEPROPID *
rgPropID
,

LPBYTE
*
lplpBuffer
,
LPDWORD
lpcbBuffer
,

HANDLE
hHeap
);

Parameters

hDbase

[in] Handle to an open database. The database must have been opened by a previous call to the CeOpenDatabaseExfunction.

dwFlags

[in] Specifies read flags. It is one of the following flags:

Value	Description
0	There are no special instructions for handling the read process.
CEDB_ALLOWREALLOC	The LocalAllocfunction was used to allocate the buffer specified by the lplpBufferparameter. The server can reallocate the buffer if it is not large enough to hold the requested properties.

lpcPropID

[in] Pointer to the number of property identifiers in the array specified by the rgPropIDparameter. If rgPropIDis NULL, this parameter receives the number of properties retrieved.

rgPropID

[in] Pointer to an array of property identifiers for the properties to be retrieved. If this parameter is NULL, CeReadRecordPropsExretrieves all properties in the record.

lplpBuffer

[out] Pointer to the address of a pointer to a buffer that receives the requested properties. If the dwFlagsparameter includes the CEDB_ALLOWREALLOC flag, the buffer may be reallocated if necessary, even if the function fails. If the CEDB_ALLOWREALLOC flag is specified and lplpBufferis NULL, the server allocates a buffer of the appropriate size in the caller's address space and returns a pointer to the buffer.

lpcbBuffer

[out] Pointer to a variable that contains the size, in bytes, of the buffer specified by the lplpBufferparameter. When CeReadRecordPropsExreturns, lpcbBufferreceives a value that indicates the actual size of the data copied to the buffer. If the buffer was too small to contain the data and CEDB_ALLOWREALLOC was not specified, this parameter can be used to calculate the amount of memory to allocate for the buffer.

hHeap

[in] For Windows CE versions 2.10 and later, handle to a application-created heap to be used when reallocating memory. This parameter is only meaningful if the CEDB_ALLOWREALLOC flag is set.

Return Values

The object identifier of the record from which the function read indicates success. Zero indicates failure. To get extended error information, call GetLastError. Possible values for GetLastErrorinclude the following:

ERROR_INVALID_PARAMETER

A parameter was invalid.

ERROR_NO_DATA

None of the requested properties were found. The output buffer and the size are valid.

ERROR_INSUFFICIENT_BUFFER

The specified buffer was not large enough, and the reallocation failed if the CEDB_ALLOWREALLOC flag was specified. The lpcbBufferparameter contains the required buffer size.

ERROR_KEY_DELETED

The record that was about to be read was deleted by another thread. If the current record was reached as a result of an autoseek, this error is not returned, and the next record is returned.

ERROR_NO_MORE_ITEMS

The current seek pointer is at the end of the database.

Return Values

Note Earlier versions (2.12 and prior) of Windows CE assigned OIDs to objects in other file systems, such as the FAT file system. These OIDs 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 OIDs and the object store is the only volume that can return an object identifier.

The CeReadRecordPropsExfunction reads the specified set of properties from the current record. If the dwFlagsparameter of CeOpenDatabaseExwas set to CEDB_AUTOINCREMENT, the function increments the seek pointer so that the next call reads the next record in the current sort order. If there was no active sort order when the database was opened, then the order in which records are returned is not predictable.

You should read all needed properties from the record in a single call. This is because the entire record is stored in a compressed format, and each time a property is read it must be decompressed. All the properties are returned in a single marshaled structure, which consists of an array of CEPROPVALstructures. There is one CEPROPVALstructure for each property requested or, if rgPropIDis NULL, there is one for each property found.

If a property was requested, such as strings or Binary Large Objects (BLOBs) that are packed in at the end of the array, the pointers in the CEPROPVALstructures point into this marshaled structure. This means that the only memory that must be freed is the original pointer to the buffer passed in to the call. Even if the function fails, it may have allocated memory on the caller's behalf. You must free the pointer returned by this function if the pointer is not NULL.

Requirements

Runs on	Versions	Defined in	Include	Link to
Windows CE OS	2.10 and later	Windbase.h	Winbase.h	Fsdbase.lib

Note This API is part of the complete Windows CE OS package as provided by Microsoft. The functionality of a particular platform is determined by the original equipment manufacturer (OEM) and some devices may not support this API.