company logo

Client :: receiveFile - Request file from server

The function copies the requested file from Server to client.

Return value:  File path ( odaba::String & )

Implementation details

odaba::String Client  :: receiveFile ( odaba::String &sSourcePath, odaba::String &sTargetPath )

The function copies the file passed from sSourcePath on the server. The target location is passed in sTargetPath . Source and target path may contain option variables. Source path option variables are resolved according to server settings.

When being send successfully, the function returns the local path for the file, otherwise an empty string.

  • sSourcePath - Source path

    The source path refers to a file location for the source file. The complete path includes file name and directory. It might, however, be defined as absolute path starting with the root device or folder or a relative path.

    In order to pass no file path, an empty string ( String() ) may be passed.

  • sTargetPath - Target path

    The target path refers to a file location for the target file. The complete path includes file name and directory. It might, however, be defined as absolute path starting with the root device or folder or a relative path.

    In order to pass no file path, an empty string ( String () ) may be passed.