4.14 WFSAsyncGetInfo

HRESULT WFSAsyncGetInfo( hService, dwCategory, lpQueryDetails, dwTimeOut, hWnd, lpRequestID )

Retrieves information from the specified service provider. The asynchronous version of WFSGetInfo.

Parameters HSERVICE hService

Handle to the service provider as returned by WFSOpen or WFSAsyncOpen.

DWORD dwCategory

See WFSGetInfo.

LPVOID lpQueryDetails

See WFSGetInfo.

DWORD dwTimeOut

Number of milliseconds to wait for completion (WFS_INDEFINITE_WAIT to specify a request that will wait until completion).

HWND hWnd

The window handle which is to receive the completion message for this request.

LPREQUESTID lpRequestID

The request identifier for this request (returned parameter).

Mode Asynchronous

Comments See WFSGetInfo. The only difference in the asynchronous version of the function is that the results (query details) returned to the application (in the WFSRESULT data structure) are pointed to by the WFS_GETINFO_COMPLETE message sent to the specified hWnd.

The application must call WFSFreeResult to deallocate the WFSRESULT data structure which is pointed to by the completion message. Note that a WFSRESULT structure may be returned even if the function completes with an error; see Section 3.13.

Messages WFS_GETINFO_COMPLETE

Error Codes If the function return is not WFS_SUCCESS, it is one of the following error conditions, indicating that the asynchronous operation was not initiated:

WFS_ERR_CONNECTION_LOST

The connection to the service is lost.

WFS_ERR_INTERNAL_ERROR

An internal inconsistency or other unexpected error occurred in the WOSA/XFS subsystem.

WFS_ERR_INVALID_CATEGORY

The dwCategory issued is not supported by this service class.

WFS_ERR_INVALID_HSERVICE

The hService parameter is not a valid service handle.

WFS_ERR_INVALID_HWND

The hWnd parameter is not a valid window handle.

WFS_ERR_INVALID_POINTER

A pointer parameter does not point to accessible memory.

WFS_ERR_NOT_STARTED

The application has not previously performed a successful WFSStartUp.

WFS_ERR_OP_IN_PROGRESS

A blocking operation is in progress on the thread; only WFSCancelBlockingCall and WFSIsBlocking are permitted at this time.

WFS_ERR_UNSUPP_CATEGORY

The dwCategory issued, although valid for this service class, is not supported by this service provider.

The following error conditions are returned via the asynchronous command completion message, as the hResult from the WFSRESULT structure. Any service-specific errors that can be returned are defined in the specifications for each service class.

WFS_ERR_CANCELED

The request was canceled by WFSCancelAsyncRequest.

WFS_ERR_DEV_NOT_READY

The function required device access, and the device was not ready or timed out.

WFS_ERR_HARDWARE_ERROR

The function required device access, and an error occured on the device.

WFS_ERR_INTERNAL_ERROR

An internal inconsistency or other unexpected error occurred in the WOSA/XFS subsystem.

WFS_ERR_INVALID_DATA

The data structure passed as input parameter contains invalid data..

WFS_ERR_SOFTWARE_ERROR

The function required access to configuration information, and an error occured on the software.

WFS_ERR_TIMEOUT

The timeout interval expired.

See also WFSGetInfo, WFSCancelAsyncRequest