IServerClient::SendFileRequest method

---

Sends a request to the IM server prior a file transfer process to obtain a possibility to send the data and to resolve a presence status of the recipients.

HRESULT SendFileRequst(
    LPDWORD lpTransferFileStruct,
    LPDWORD lpFilesArray,
    LPDWORD lpRecipientsArray,
    LPDWORD lpdwExtendedCode
);

Parameters

lpTransferFileStruct

[in] Pointer to a TRANSFER_FILE_STRUCT structure that contains information on the files/directories that are about to be sent.

lpFilesArray

[in] Pointer to an array of FILE_NAME type that contains paths of the files/directories that are about to be sent.

lpRecipientsArray

[in] Pointer to an array of MULTIPLE_RECIPIENT_STRUCT structures that contains recipients of the file transfer.

lpdwExtendedCode

[out] Pointer to a DWORD variable that gets an extended code if error result is returned. For available codes see Available Extended Codes topic.

Return Value

S_OK

The function was successful. Check lpdwExtendedCode variable to get extended information.

E_INVALIDARG

One or more arguments are incorrect.

E_FAIL

Some error occurred in the function. Check lpdwExtendedCode variable to get extended information on the error.

Remarks

Check the extended code if the file data must be delivered to offline users. In cases when the returned value is TRANSFER_FILE_ALL_RECIPIENTS_OFFLINE or TRANSFER_FILE_SOME_RECIPIENTS_OFFLINE the dwTransferFlags member of the TRANSFER_FILE_STRUCT structure passed to subsequent call of IServerClient::SendFile should have FILE_TRANSFER_FLAG_OFFLINE flag set to allow the IM server to keep files for a scheduled delivery.