<< Back


FVSDK_RemoveDirectory

Synopsis

FVSDK_ERROR_CODE FVSDK_RemoveDirectory(FVSDK_Session* pSession, LPCTSTR pszPathName);

Description

This function deletes the directory specified by pszPathName. This function does not remove the contents of directories. Usually, if a directory contains sub directories and/or files, the server will return a failure response code when issued the RMD command.

Parameters

pSession

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

pszPathName

The full path name to the directory to be deleted.

Return Value

FVSDK_YES if the directory was successful deleted; FVSDK_NO if the directory could not be deleted. Error codes can be found in FVSDK_ErrorCodes.h.

Example

// remove the directory
if (FVSDK_RemoveDirectory(pSession, "/pub/test") != FVSDK_YES)
    AfxMessageBox("Unable to delete the directory.");