Serial Framework C++ Edition

◆ SetPath()

int SetPath ( const tstring Dir,
const bool  Create 
)
protected

Changes the current directory on the server's side.

Parameters
DirThe directory name. If the Dir value is ".." it tells to the server to backup a level (go one level up). If the Dir is an empty string it tells to the server to go to the default (root) directory).
CreateIf this parameter is set to True it tells server to create new directory with the given name. If this parameter is set to False and the directory specified in the Dir parameter does not exists the WCL_E_OBEX_BAD_REQUEST or the WCL_E_OBEX_FORBIDDEN error returned as the operation complete result.

The method sets the current directory on the receiving side in order to enable transfers that need additional path information. For instance, when a nested set of directories is sent between two machines, SetPath is used to create the directory structure on the receiving side.