<< Back


FVSDK_ValidSession

Synopsis

FVSDK_ERROR_CODE FVSDK_ValidSession(FVSDK_Session* pSession);

Description

Checks the administrative elements of a FVSDK_Session structure for validity. This function returns okay when pSession is not NULL, the nSize element matches the size of a FVSDK_Session structure, and the nVersion element matches the FVSDK_SESSION_CURRENT_VERSION macro. This function is generally used internally by the FTP Voyager SDK, but can be used externally as well.

Parameters

pSession

A pointer to the FVSDK_Session to check.

Return Value

FVSDK_OK if pSession appears to be valid, FVSDK_INVALID_PARAMETER if pSession is NULL, FVSDK_INVALID_SESSION_SIZE if the nSize element is incorrect, FVSDK_INVALID_SESSION_VERSION if nVersion is not FVSDK_SESSION_CURRENT_VERSION.

Example

// verify the session
if (FVSDK_ValidSession(pSession) != FVSDK_OK)
    AfxMessageBox("Session is invalid.");