IBackgroundCopyJob2::SetReplyFileName method

Specifies the name of the file to contain the reply data from the server application. Call this method only if the job's type is BG_JOB_TYPE_UPLOAD_REPLY.

Syntax

HRESULT SetReplyFileName(
  [in] LPWSTR ReplyFileNamePathSpec
);

Parameters

• ReplyFileNamePathSpec [in]
  Null-terminated string that contains the full path to the reply file. DO generates the file name if ReplyFileNamePathSpec is NULL or an empty string. You cannot use wildcards in the path or file name, and directories in the path must exist. The path is limited to MAX_PATH, not including the null terminator. The user must have permissions to write to the directory. DO does not support NTFS streams. Instead of using network drives, which are session specific, use UNC paths (for example, \\server\share\path\file). Do not include the \\? prefix in the path.

Return value

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

Remarks

DO generates the file name if you do not call the SetReplyFileName method before calling the IBackgroundCopyJob::Resume method for the first time.

If DO generates the file name, the reply file is written to the same directory as the local upload file.

You can call the SetReplyFileName method anytime before DO begins downloading the reply from the server application; the method fails if the download has begun.

The reply file is available to the client after calling the IBackgroundCopyJob::Complete method. To retrieve the reply data before calling the Complete method, call the IBackgroundCopyJob2::GetReplyData method.

The file is empty if the server application did not provide a reply.

Requirements

See also

IBackgroundCopyJob2

IBackgroundCopyJob::GetReplyData

IBackgroundCopyJob::GetReplyFileName