|
NAME moUUEncode - encode a binary buffer to ASCII
VERSION
Version: 1.2.0
SYNOPSIS
void moUUEncode(moWCString& out, const moBuffer& in, int mode, const moWCString& name);
PARAMETERS
out - the resulting ASCII buffer
in - the input buffer
mode - the permissions of the file (like chmod(1))
name - the name of the file
DESCRIPTION
This function will encode a binary buffer into an ASCII
string which is printable in emails. This format is the
same as the uuencode(1) and uudecode(1) tools understand.
SEE ALSO
moUUDecode
COPYRIGHTS
This documentation and the code being documented is proprietary and cannot be duplicated without the express and written consent of Made to Order Software Coporation.
Copyright (c) 1999-2007 by Made to Order Software Corporation
All rights reserved.
AUTHORS
Alexis Wilke, Doug Barbieri
NAME
moUUDecode - decode an ASCII buffer back to binary
VERSION
Version: 1.2.0
SYNOPSIS
mo_uudecode_error_t moUUDecode(const moWCString& in, moBuffer& out, int& mode, moWCString& name);
PARAMETERS
in - the input ASCII string
out - the resulting output buffer
mode - the permissions of the file as read from the input (like chmod(1))
name - the name of the file as read from the input
DESCRIPTION
This function will decode an ASCII buffer back to binary
This expected input format is the same as the uuencode(1)
and uudecode(1) tools understand.
The input string can start with blanks. These will be
skipped (spaces, new-lines, carriage returns)
RETURN VALUE
This function returns MO_UUDECODE_ERROR_NONE on success.
The other error codes are describe below:
. MO_UUDECODE_ERROR_NOBEGIN
The "begin ..." wasn't found.
. MO_UUDECODE_ERROR_BADMODE
The file mode is invalid (not an octal value from
0 to 07777)
. MO_UUDECODE_ERROR_BADNAME
The filename isn't valid (usually empty.)
. MO_UUDECODE_ERROR_EMPTY
The end of the string was found before the filename.
. MO_UUDECODE_ERROR_BADLENGTH
The length of a line is not valid (too small or large)
. MO_UUDECODE_ERROR_BADCHAR
An encoded character is invalid (not in the acceptable
range for UUEncode).
. MO_UUDECODE_ERROR_BADEND
The "end" wasn't found before the end of the string.
SEE ALSO
moUUEncode
COPYRIGHTS
This documentation and the code being documented is proprietary and cannot be duplicated without the express and written consent of Made to Order Software Coporation.
Copyright (c) 1999-2007 by Made to Order Software Corporation
All rights reserved.
AUTHORS
Alexis Wilke, Doug Barbieri
Links:
molib
the sandbox
|