<< Back


FVSDK_Working

Synopsis

FVSDK_ERROR_CODE FVSDK_Working(FVSDK_Session* pSession);

Description

Checks to see whether or not the FTP Voyager SDK is working on another operation, or whether it's available. Since FTP operations can be lengthy operations, FVSDK sends Windows messages back to the main message loop. This can cause unwanted results, such as attempting to connect while a connection is already in progress. Using FVSDK_Working() can prevent these types of unwanted results.

Parameters

pSession

A pointer to the FVSDK_Session to check.

Return Value

FVSDK_YES if the FTP Voyager SDK is busy working on another operation; FVSDK_NO if it is not. Error codes can be found in FVSDK_ErrorCodes.h.

Example

// don't do anything if the FTP Voyager SDK is working on another operation
if (FVSDK_Working(pSession) == FVSDK_YES)
    return ;