Skip to content

CeReadRecordProps.md

Latest commit

 

History

History
73 lines (51 loc) · 1.99 KB

CeReadRecordProps.md

File metadata and controls

73 lines (51 loc) · 1.99 KB

Home

Function name : CeReadRecordProps

Group: Remote Application Programming (RAPI) - Library: rapi

This function reads properties from the current record.

Code examples:

Pocket PC: custom RAPI class for operating with the Object Store Databases

Declaration:

CEOID CeReadRecordProps(
  HANDLE hDbase,
  DWORD dwFlags,
  LPWORD lpcPropID,
  CEPROPID* rgPropID,
  LPBYTE* lplpBuffer,
  LPDWORD lpcbBuffer
);

FoxPro declaration:

DECLARE INTEGER CeReadRecordProps IN rapi;
	INTEGER   hDbase,;
	INTEGER   dwFlags,;
	INTEGER @ lpcPropID,;
	INTEGER   rgPropID,;
	INTEGER @ lplpBuffer,;
	INTEGER @ lpcbBuffer

Parameters:

hDbase [in] Handle to an open database. The database must have been opened by a previous call to the CeOpenDatabase (RAPI) function.

dwFlags [in] Specifies a bitmask of read flags.

lpcPropID [in/out] Pointer to the number of property identifiers in the array specified by the rgPropID parameter. If rgPropID is 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, CeReadRecordProps (RAPI) retrieves all properties in the record.

lplpBuffer [out] Pointer to a long pointer to a buffer that receives the requested properties.

lpcbBuffer [out] Long pointer to a variable that contains the size, in bytes, of the buffer specified by the lplpBuffer parameter.

Return value:

The object identifier of the record from which the function read indicates success.

Comments:

IF dwFlags parameter is set to CEDB_ALLOWREALLOC with lplpBuffer set to zero, the LocalAlloc function is used by the server behind the scene to allocate the buffer.