- Contents
SOAP API Developer's Guide
SOAP Base64 Encode File
Reads the specified file as binary data and encodes it into a base64 string. Encoding a file prepares it for transport inside a SOAP payload. For example, a SOAP request might encode a wave file, and send it to CIC server. SOAP does not mandate a maximum line width for base64 encoded data. Some other protocols, such as MIME, do. This tool can be used to send any kind of data through SOAP requests. For example, you could encode a wave file.
Exit Paths: Success, File Not Found, Access Denied, Failure
|
Parameter |
Dir |
Type |
Remarks |
|
Filename |
IN |
String |
Filename and path of the file to encode |
|
Max Line Width |
IN |
Integer |
Optional. Maximum width of a line in characters. –1 = unlimited (default). |
|
Line Separator |
IN |
String |
Optional. String inserted as line separator. Default: "\r\n" (CR/LF) |
|
Encoded Data |
OUT |
String |
Base64 encoded content of the file |