UTL_ENCODE , 2 of 2

Summary of UTL_ENCODE Subprograms

Table 94-1 UTL_ENCODE Subprograms

Subprogram	Description
BASE64_ENCODE Function	Encodes the binary representation of the `RAW` value into base 64 elements and returns it in the form of a `RAW` string
BASE64_DECODE Function	Reads the base 64-encoded `RAW` input string and decodes it to its original `RAW` value
UUENCODE Function	Reads the `RAW` input string and encodes it to the corresponding uuencode format string
UUDECODE Function	Reads the `RAW` uuencode format input string and decodes it to the corresponding `RAW` string
QUOTED_PRINTABLE_ENCODE Function	Reads the `RAW` input string and encodes it to the corresponding quoted printable format string
QUOTED_PRINTABLE_DECODE Function	Reads the `varchar2` quoted printable format input string and decodes it to the corresponding `RAW` string

BASE64_ENCODE Function

This function encodes the binary representation of the RAW value into base 64 elements and returns it in the form of a RAW string.

Syntax

UTL_ENCODE.BASE64_ENCODE (
   r  IN RAW) 
RETURN RAW;

Pragmas

pragma RESTRICT_REFERENCES(base64_encode, WNDS, RNDS, WNPS, RNPS);

Parameters

Table 94-2 BASE64_ENCODE Function Parameters

Parameter	Description
`r`	The RAW value to be encoded. There are no defaults or optional parameters.

Returns

Table 94-3 BASE64_ENCODE Function Returns

Return	Description
RAW	Contains the encoded base 64 elements

BASE64_DECODE Function

This function reads the base 64-encoded RAW input string and decodes it to its original RAW value.

Syntax

UTL_ENCODE.BASE64_DECODE (
   r  IN RAW) 
RETURN RAW;

Pragmas

pragma RESTRICT_REFERENCES(base64_decode, WNDS, RNDS, WNPS, RNPS);

Parameters

Table 94-4 BASE64_DECODE Function Parameters

Parameter	Description
`r`	The RAW string containing base 64-encoded data. There are no defaults or optional parameters.

Returns

Table 94-5 BASE64_DECODE Function Returns

Return	Description
RAW	Contains the decoded string

UUENCODE Function

This function reads the RAW input string and encodes it to the corresponding uuencode format string. The output of this function is cumulative, in that it can be used to encode large data streams, by splitting the data stream into acceptably sized RAW values, encoded, and concatenated into a single encoded string. Also see "UUDECODE Function".

Syntax

UTL_ENCODE.UUENCODE (
   r          IN RAW,
   type       IN PLS_INTEGER DEFAULT 1,
   filename   IN VARCHAR2 DEFAULT NULL,
   permission IN VARCHAR2 DEFAULT NULL) RETURN RAW;

Pragmas

pragma RESTRICT_REFERENCES(uuencode, WNDS, RNDS, WNPS, RNPS);

Parameters

Table 94-6 UUENCODE Function Parameters

Parameter	Description
r	`RAW` string
type	Optional number parameter containing the type of uuencoded output. Options: complete--a defined PL/SQL constant with a value of `1`. (default) header_piece middle_piece end_piece
filename	Optional `varchar2` parameter containing the uuencode filename; the default is `uuencode.txt`
permission	Optional `varchar2` parameter containing the permission mode; the default is `0` (a text string zero).

Returns

Table 94-7 UUENCODE Function Returns

Return	Description
RAW	Contains the uuencode format string

UUDECODE Function

This function reads the RAW uuencode format input string and decodes it to the corresponding RAW string. See "UUENCODE Function" for discussion of the cumulative nature of UUENCODE and UUDECODE for data streams.

Syntax

UTL_ENCODE.UUDECODE (
   r  IN RAW) 
RETURN RAW;

Pragmas

pragma RESTRICT_REFERENCES(uudecode, WNDS, RNDS, WNPS, RNPS);

Parameters

Table 94-8 DUDECODE Function Parameters

Parameter	Description
`r`	The RAW string containing the uuencoded data string. There are no defaults or optional parameters.

Returns

Table 94-9 UUDECODE Function Returns

Return	Description
RAW	The decoded `RAW` string

QUOTED_PRINTABLE_ENCODE Function

This function reads the RAW input string and encodes it to the corresponding quoted printable format string.

Syntax

UTL_ENCODE.QUOTED_PRINTABLE_ENCODE (
   r  IN RAW
RETURN RAW;

Pragmas

pragma RESTRICT_REFERENCES(quoted_printable_encode, WNDS, RNDS,WNPS, RNPS);

Parameters

Table 94-10 QUOTED_PRINTABLE_ENCODE Function Parameters

Parameter	Description
`r`	The RAW string. There are no defaults or optional parameters.

Returns

Table 94-11 QUOTED_PRINTABLE_ENCODE Function Returns

Return	Description
RAW	Contains the quoted printable string

QUOTED_PRINTABLE_DECODE Function

This function reads the varchar2 quoted printable format input string and decodes it to the corresponding RAW string.

Syntax

UTL_ENCODE.QUOTED_PRINTABLE_DECODE (
   r  IN RAW
RETURN RAW;

Pragmas

pragma RESTRICT_REFERENCES(quoted_printable_decode, WNDS, RNDS, WNPS, RNPS);

Parameters

Table 94-12 QUOTED_PRINTABLE_DECODE Function Parameters

Parameters	Description
`r`	The RAW string containing a quoted printable data string. There are no defaults or optional parameters.

Returns

Table 94-13 QUOTED_PRINTABLE_DECODE Function Returns

Return	Description
RAW	The decoded string