IBackgroundCopyJob2::GetReplyData method

Retrieves an in-memory copy of the reply data from the server application. Call this method only if the job's type is BG_JOB_TYPE_UPLOAD_REPLY and its state is BG_JOB_STATE_TRANSFERRED.

Syntax

HRESULT GetReplyData(
  [in, out] BYTE   **ppBuffer,
  [out]     UINT64 *pSize
);

Parameters

• ppBuffer [in, out]
  Buffer to contain the reply data. The method sets ppBuffer to NULL if the server application did not return a reply. Call the CoTaskMemFree function to free ppBuffer when done.

• pSize [out]
  Size, in bytes, of the reply data in ppBuffer.

Return value

This method returns the following HRESULT values, as well as others.

Remarks

The GetReplyData method lets you read the reply data before or after you call the IBackgroundCopyJob::Complete method. However, to read the reply data from the reply file, you must first call the Complete method; the file is not available to the client until you call the Complete method.

The GetReplyData method returns BG_E_TOO_LARGE if the reply data exceeds 1 MB (pSize contains the size of the reply data). To retrieve the reply if it exceeds 1 MB, call the IBackgroundCopyJob2::GetReplyFileName method to retrieve the file name. Then, open the file and read the reply data directly.

Requirements

See also

IBackgroundCopyJob2

IBackgroundCopyJob2::GetReplyFileName

IBackgroundCopyJob2::SetReplyFileName