<< Back


FVSDK_TransferMessage

Synopsis

FVSDK_ERROR_CODE FVSDK_TransferMessage(FVSDK_Session* pSession, DWORD dwTransferStatusHandle, DWORD dwMessage, DWORD dwParams);

Description

Sends a message to an active transfer. Use this function to cancel a transfer, skip the current file in a transfer, or stop after the current file completes.

Parameters

pSession

A pointer to the FVSDK_Session that is to perform the operation.

dwTransferStatusHandle

The transfer status handle. The transfer status handle is the handle found in the FVSDK_TransferStatus structure sent via the pfnNotifyTransferStatus callback function.

dwMessage

The message to send to the transfer identified by dwTransferStatusHandle. This value may be one of the following as found in FVSDK_TransferStatus.h:
FVSDK_TRANSFER_STATUS_CANCEL cancel the transfer all together
FVSDK_TRANSFER_STATUS_SKIP_FILE skip the current file (multiple file transfers only)
FVSDK_TRANSFER_STATUS_STOP_AFTER_DONE stop after the current file completes (multiple file transfers only)

dwParams

Unused. This value must be set to zero.

Return Value

FVSDK_OK if successful; error codes can be found in FVSDK_ErrorCodes.h.

Example

// cancel the transfer
FVSDK_TransferMessage(pSession, dwTransferStatusHandle, FVSDK_TRANSFER_STATUS_CANCEL, 0)