ISOAPBase64::EncodeFile Method

Synopsis

Encodes the binary content of a file to create a Base64 encoded string.

Function Prototype

HRESULT EncodeFile(

   [in] BSTR bstrFilename,

   [in,optional] VARIANT vtMaxLineWidth,

   [in,optional] VARIANT vtLineSeparator,

   [out, retval] BSTR* pbstrResult

);

C/C++ Syntax

HRESULT EncodeFile(BSTR bstrFilename, VARIANT vtMaxLineWidth, VARIANT vtLineSeparator, BSTR* pbstrResult);

Parameters

bstrFilename

The Name (and Path) of the file to encode.

vtMaxLineWidth

This optional input parameter is a VARIANT that sets the maximum width of a line of encoded data in characters. The default is 0, which indicates no line breaks.

vtLineSeparator

This optional parameter specifies the characters used to separate lines (e.g. the characters that will be written to create a line break).  The default is CRLF (\r\n).

pbstrResult

The return value is a Base64 encoded string.