CeGetDatabaseProps (EDB)

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

This function obtains some or all properties of a database.

Syntax

BOOL CeGetDatabaseProps (
  HANDLE hDatabase,
  LPWORD lpcPropID,
  CEPROPID* prgPropID,
  CEPROPSPEC* prgProps
);

Parameters

• hDatabase
  [in] Handle to an open database. This handle is obtained by calling the CeOpenDatabaseInSession (EDB) function.

• lpcPropID
  [in, out] Number of property IDs in the prgPropID ** array.

• prgPropID
  [in] Pointer to an array of property IDs that specifies the properties to be retrieved. If this parameter is set to NULL the first *lpcPropID properties are returned. This enables properties to be returned without knowing the property IDs.

• prgProps
  [in, out] Array of CEPROPSPEC (EDB) in which the property information is to be placed. If the value of this parameter is set to NULL, the number of properties in the database is returned in *lpcPropID. The caller must set the wVersion value of the elements of prgProps to CEPROPSPEC_VERSION before calling this function.

  The pwszPropName field of CEPROPSPEC must be set to point to an empty string buffer to pre-allocate space for property names.

Return Value

TRUE indicates success. FALSE indicates failure. To get extended error information, call GetLastError. The following table shows possible values.

Remarks

This function can be used to perform any of the following operations:

• Find the number of properties in a database. Set prgProps to NULL.
• Select only a subset of properties. Set required property IDs in prgPropID.
• Return properties, even if their property IDs are not known. Set prgPropID to NULL.

If any of the properties specified in prgPropID does not exist in the database, the corresponding positions in prgProps sets the wVersion value to zero.

Properties are added to a database by using the CeAddDatabaseProps (EDB) function and removed by using the CeRemoveDatabaseProps (EDB) function.

Requirements

See Also

Reference

EDB Functions
CeOpenDatabaseInSession (EDB)
CeAddDatabaseProps (EDB)
CeRemoveDatabaseProps (EDB)
CEPROPSPEC (EDB)