FileEncoder.EncodeFile Method (String,
String, EncodingType)
Encodes a file, storing the contents as printable text in the
specified file.
[Visual Basic]
Overloads Public Function EncodeFile( _
ByVal
inputFile As
String, _
ByVal
outputFile As
String, _
ByVal
encodingType As
EncodingType _
) As
Boolean
[C#]
public
bool EncodeFile(
string inputFile,
string outputFile,
EncodingType encodingType
);
Parameters
- inputFile
- A string which specifies the name of the file to be encoded.
The file must exist, and it must be a regular file that can be
opened for reading by the current process. An error will be
returned if a character device, such as CON: is specified as the
file name.
- outputFile
- The name of the file that is to contain the encoded file data.
If the file exists, it must be a regular file that can be opened
for writing by the current process and will be overwritten. If the
file does not exist, it will be created. An error will be returned
if a character device, such as CON: is specified as the file
name.
- encodingType
- An EncodingType
enumeration value which specifies the type of encoding which should
be used.
Return Value
A boolean value which specifies if the method was successful or
not. A return value of True indicates that the method call
completed successfully. A return value of False indicates that the
method failed and the application should check the value of the
LastError property.
See Also
FileEncoder Class |
SocketTools Namespace | FileEncoder.EncodeFile
Overload List