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.
A version of this page is also available for
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 wVersionmember 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 lpDBInfoparameter is set to NULL.

  • The wVersionmember 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