8.1 WFSRESULT

This structure has three functions:

• It is the parameter which returns the results of the synchronous WFSLock, WFSExecute and WFSGetInfo commands.

• It is pointed to by all command completion messages, and delivers completion status (as a result handle) and results data (if any) for all asynchronous API and SPI calls.

• It is pointed to by all event notification messages to deliver their contents.

Note that even though in many cases one or more members of this structure are not used, the adoption of a single, standard structure for request results simplifies the implementation and maintenance of applications, service providers and the XFS Manager itself.

typedef struct _wfs_result {
 REQUESTID RequestID;
 HSERVICE hService;
 TIMESTAMP tsTimestamp;
 HRESULT hResult;
 union {
  DWORD  dwCommandCode;
  DWORD  dwEventID;
 } u;
 LPVOID  lpBuffer;
} WFSRESULT, * LPWFSRESULT;

The members of this structure are:

Field Description

RequestID Request ID of the completed command; not used for event notifications other than Execute events

hService Service handle identifying the session that created the result

tsTimestamp Time the event occurred (local time, in a Win32 SYSTEMTIME structure)

hResult Result handle (note that for synchronous WFSExecute and WFSGetInfo commands, this value is identical to the synchronous function return value)

u.dwCommandCode WFSExecute “command” code or WFSGetInfo “category” code; not used for other command completions

u.dwEventID ID of the event (for unsolicited events)

lpBuffer Pointer to the results of the command (if any) or the contents of the event notification