CeFindAllDatabases (RAPI) (Compact 7)

3/12/2014

This function retrieves information about all databases of a specified type residing on a remote Windows Embedded Compact-based device.

Syntax

BOOL CeFindAllDatabases(
  DWORD dwDbaseType, 
  WORD wFlags, 
  LPWORD cFindData, 
  LPLPCEDB_FIND_DATA ppFindData 
); 

Parameters

  • dwDbaseType
    [in] Specifies the type identifier of the databases to seek. This value is application-defined and is set when the database is created using the CeCreateDatabaseand CeCreateDatabaseEx functions.
  • 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.dwDbaseType member.

    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 receive 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 (RAPI).

Return Value

Nonzero indicates success. Zero indicates failure. To get extended error information, call CeGetLastError and CeRapiGetError.

Requirements

Header

rapi.h

Library

rapi.lib

See Also

Reference

RAPI Functions