IBufferObjectDataRequest::RequestAsync method

Requests to get the raw contents of an object (buffer, texture, render target view, etc.)

Syntax

HRESULT RequestAsync(
   EventID                     eventID,
   DWORD                       RequestedDataUID,
   BSTR                        File,
   BSTR                        Format,
   IBufferObjectDataCallback * requestCallback,
   DWORD                       requestCookie,
   DWORD                       progressIntervalMsecs
);

Parameters

eventID
The specified event to match the buffer's content to (for example, a render target could change over time).

RequestedDataUID
The address of the specified object.

File
A COM string that contains the pathname of the file where results are written.

Format
Not currently used. A COM string that specifies the output format.

requestCallback
The address of callback used to notify the host of results.

requestCookie
A cookie that uniquely identifies the request, and can be used to signal for it to be cancelled.

progressIntervalMsecs
Not used.

Return value

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Requirements

See also

IBufferObjectDataRequest