CeFindAllDatabases (RAPI) (Windows CE 5.0)

Send Feedback

This function retrieves information about all databases of a given type residing on the Windows CE device. The function copies information to an array of CEDB_FIND_DATA structures.

CeFindAllDatabases is a remote application programming interface (RAPI), which enables an application running on a desktop computer to make function calls on a Windows CE–based device.

BOOLCeFindAllDatabases(DWORDdwDbaseType, WORDwFlags, LPWORDcFindData, LPLPCEDB_FIND_DATAppFindData);

Parameters

  • dwDbaseType
    [in] Specifies the type identifier of the databases to seek.
  • wFlags
    [in] Members of the CEDB_FIND_DATA structure that are to be retrieved. This parameter can be a combination of the following values.
    Value Description
    FAD_OID Retrieves the OidDb member.
    FAD_FLAGS Retrieves the DbInfo.dwFlags member.
    FAD_NAME Retrieves the DbInfo.szDbaseName member.
    FAD_TYPE Retrieves the DbInfo.dwDbaseTypemember.
    FAD_NUM_RECORDS Retrieves the DbInfo.dwNumRecords member.
    FAD_NUM_SORT_ORDER Retrieves the DbInfo.dwNumSortOrder member.
    FAD_SORT_SPECS Retrieves the DbInfo.rgSortSpecs member.
  • cFindData
    [out] Pointer to a variable that receives a count of the items found.
  • ppFindData
    [out] Pointer to the pointer to an array of CEDB_FIND_DATA structures that receives information about the found items. It is the application's responsibility to free the memory used by the array. To free the memory the application must call CeRapiFreeBuffer.

Return Values

TRUE indicates success. FALSE indicates failure. To determine if a function failed because of RAPI errors, call CeRapiGetError. To determine if a function failed because of non-RAPI errors, call CeGetLastError.

Remarks

When writing applications for Windows CE 1.0 and 1.01, use the PegFindAllDatabases function.

Requirements

OS Versions: Windows CE 2.0 and later.
Header: Rapi.h.
Link Library: Rapi.lib.

See Also

RAPI Functions | CeGetLastError | CeRapiFreeBuffer | CeRapiGetError

Send Feedback on this topic to the authors

Feedback FAQs

© 2006 Microsoft Corporation. All rights reserved.