CeGetDBInformationByHandle (EDB)

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

This function obtains information about an open database by using the handle of the database.

Syntax

BOOL CeGetDBInformationByHandle(
  HANDLE hDbase, 
  BY_HANDLE_DB_INFORMATION* lpDBInfo
);

Parameters

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

• lpDBInfo
  [in, out] Pointer to a BY_HANDLE_DB_INFORMATION (EDB) structure. The caller must set the wVersion member to BY_HANDLE_DB_INFORMATION_VERSION before calling this function.

Return Value

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

Return Value	Description
ERROR_INVALID_HANDLE	The hDbase parameter is set to NULL or equal to INVALID_HANDLE_VALUE.
ERROR_INVALID_PARAMETER	Indicates one of the following: The lpDBInfo parameter is set to NULL. The wVersion member is not equal to BY_HANDLE_DB_INFORMATION_VERSION.

Requirements

Header	windbase.h
Library	coredll.lib
Windows Embedded CE	Windows CE 5.0 and later
Windows Mobile	Windows Mobile Version 5.0 and later

See Also

Reference

EDB Functions
CeOpenDatabaseInSession (EDB)
BY_HANDLE_DB_INFORMATION (EDB)