<< Back


FVSDK_Stop

Synopsis

FVSDK_ERROR_CODE FVSDK_Stop(FVSDK_Session* pSession);

Description

Issues a stop or cancel command to the FTP Voyager SDK. This command attempts to stop the current operation. In some cases, the current operation will stop immediately; for others, the operation may cancel after some extended time.

Parameters

pSession

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

Return Value

FVSDK_OK if the stop operation was issued; error codes can be found in FVSDK_ErrorCodes.h.

Example

// the user wants to stop the current operation
FVSDK_Stop(pSession);