:SetFileStructure()
Class
Syntax
:SetFileStructure( nType, [hSession] ) -> lSuccess
Parameters
|
|
nType |
Numeric. Specifies the default type of file structure being opened or created on the remote server. See table below for possible values. |
|
|
hSession |
Optional: If hSession is not passed, the value in :Session will be used |
The nType parameter can be one of the following values.
|
Value |
Description |
|
FILE_STRUCT_NONE |
The file has no inherent structure and is considered to be a stream of bytes. This is the default structure for file transfers. |
|
FILE_STRUCT_RECORD |
The file uses a record structure. This file structure is currently not supported. |
|
FILE_STRUCT_PAGE |
The file uses a page structure. This file structure is currently not supported. |
Return
Logical indicating Success.
Returns .T. if the operation succeeds, otherwise returns .F.
To get further error information see :nErr and :cErr
To see the remote server's response, see :GetResultCode() and :GetResultString().
Description
The :SetFileStructure() method sets the default file structure for the current client session, which indicates what type of file is being opened or created on the remote server.
The file structure should be set before a file is opened or created on the remote server. Once the file type is set, it is in effect for all files that are subsequently opened or created.
See Also
:OpenFile(), :SetFileMode(), :SetFIleType() :SetPassiveMode()