DBMS_MGWMSG, 4 of 4

Summary of DBMS_MGWMSG Subprograms

Table 32-10 DBMS_MGWMSG Subprograms

Subprogram	Description
NVARRAY_ADD Procedure	Appends a name-value element to the end of a name-value array
NVARRAY_GET Function	Gets the name-value element of the name you specify in `p_name` from a name-value array
NVARRAY_GET_BOOLEAN Function	Gets the value of the name-value array element that you specify in `p_name` and with the `BOOLEAN_VALUE` value type
NVARRAY_GET_BYTE Function	Gets the value of the name-value array element that you specify in `p_name` and with the `BYTE_VALUE` value type
NVARRAY_GET_SHORT Function	Gets the value of the name-value array element that you specify in `p_name` and with the `SHORT_VALUE` value type
NVARRAY_GET_INTEGER Function	Gets the value of the name-value array element that you specify in `p_name` and with the `INTEGER_VALUE` value type
NVARRAY_GET_LONG Function	Gets the value of the name-value array element that you specify in `p_name` and with the `LONG_VALUE` value type
NVARRAY_GET_FLOAT Function	Gets the value of the name-value array element that you specify in `p_name` and with the `FLOAT_VALUE` value type
NVARRAY_GET_DOUBLE Function	Gets the value of the name-value array element that you specify in `p_name` and with the `DOUBLE_VALUE` value type
NVARRAY_GET_TEXT Function	Gets the value of the name-value array element that you specify in `p_name` and with the `TEXT_VALUE` value type
NVARRAY_GET_RAW Function	Gets the value of the name-value array element that you specify in `p_name` and with the `RAW_VALUE` value type
NVARRAY_GET_DATE Function	Gets the value of the name-value array element that you specify in `p_name` and with the `DATE_VALUE` value type
NVARRAY_FIND_NAME Function	Searches a name-value array for the element with the name you specify in `p_name`
NVARRAY_FIND_NAME_TYPE Function	Searches a name-value array for an element with the name and value type you specify

NVARRAY_ADD Procedure

This procedure appends a name-value element to the end of a name-value array.

Syntax

DBMS_MGWMSG.NVARRAY_ADD (
   p_array  IN OUT SYS.MGW_NAME_VALUE_ARRAY_T,
   p_value  IN     SYS.MGW_NAME_VALUE_T );

Parameters

Table 32-11 NVARRAY_ADD Procedure Parameters

Parameter	Description
`p_array`	The name-value array instance. On input, the array to modify. If `NULL,` a new array is created. On output, the modified array.
`p_value`	The value to add. If `NULL,` `p_array` is not changed.

NVARRAY_GET Function

This function gets the name-value element of the name you specify in p_name from a name-value array.

Syntax

DBMS_MGWMSG.NVARRAY_GET (
   p_array    IN SYS.MGW_NAME_VALUE_ARRAY_T,
   p_name     IN VARCHAR2,
   p_compare  IN BINARY_INTEGER DEFAULT CASE_SENSITIVE )
RETURN SYS.MGW_NAME_VALUE_T;

Parameters

Table 32-12 NVARAAY_GET Function Parameters

Parameter	Description
`p_array`	The name-value array
`p_name`	The value name
`p_compare`	Name comparison method. Values: `CASE_SENSITIVE, CASE_INSENSITIVE`

Returns

The matching element, or NULL if the specified name is not found.

NVARRAY_GET_BOOLEAN Function

This function gets the value of the name-value array element that you specify in p_name and with the BOOLEAN_VALUE value type.

Syntax

DBMS_MGWMSG.NVARRAY_GET_BOOLEAN (
   p_array    IN SYS.MGW_NAME_VALUE_ARRAY_T,
   p_name     IN VARCHAR2,
   p_compare  IN BINARY_INTEGER DEFAULT CASE_SENSITIVE )
RETURN INTEGER;

Parameters

Table 32-13 NVARRAY_GET_BOOLEAN Function Parameters

Parameter	Description
`p_array`	The name-value array
`p_name`	The value name
`p_compare`	Name comparison method. Values: `CASE_SENSITIVE, CASE_INSENSITIVE`

Returns

The value, or NULL if the specified name is not found or if a type mismatch exists.

NVARRAY_GET_BYTE Function

This function gets the value of the name-value array element that you specify in p_name and with the BYTE_VALUE value type.

Syntax

DBMS_MGWMSG.NVARRAY_GET_BYTE (
   p_array    IN SYS.MGW_NAME_VALUE_ARRAY_T,
   p_name     IN VARCHAR2,
   p_compare  IN BINARY_INTEGER DEFAULT CASE_SENSITIVE )
RETURN INTEGER;

Parameters

Table 32-14 NVARRAY_GET_BYTE Function

Parameter	Description
`p_array`	The name-value array
`p_name`	The value name
`p_compare`	Name comparison method. Values: `CASE_SENSITIVE, CASE_INSENSITIVE`

Returns

The value, or NULL if the specified name is not found or if a type mismatch exists.

NVARRAY_GET_SHORT Function

This function gets the value of the name-value array element that you specify in p_name and with the SHORT_VALUE value type.

Syntax

DBMS_MGWMSG.NVARRAY_GET_SHORT (
   p_array    IN SYS.MGW_NAME_VALUE_ARRAY_T,
   p_name     IN VARCHAR2,
   p_compare  IN BINARY_INTEGER DEFAULT CASE_SENSITIVE )
RETURN INTEGER;

Parameters

Table 32-15 NVARRAY_GET_SHORT Function Parameters

Parameter	Description
`p_array`	The name-value array
`p_name`	The value name
`p_compare`	Name comparison method. Values: `CASE_SENSITIVE, CASE_INSENSITIVE`

Returns

The value, or NULL if the specified name is not found or if a type mismatch exists.

NVARRAY_GET_INTEGER Function

This function gets the value of the name-value array element that you specify in p_name and with the INTEGER_VALUE value type.

Syntax

DBMS_MGWMSG.NVARRAY_GET_INTEGER (
   p_array    IN SYS.MGW_NAME_VALUE_ARRAY_T, 
   p_name     IN VARCHAR2,
   p_compare  IN BINARY_INTEGER DEFAULT CASE_SENSITIVE )  
RETURN INTEGER;

Parameters

Table 32-16 NVARRAY_GET_INTEGER Function Parameters

Parameter	Description
`p_array`	The name-value array
`p_name`	The value name
`p_compare`	Name comparison method. Values: `CASE_SENSITIVE, CASE_INSENSITIVE`

Returns

The value, or NULL if the specified name is not found or if a type mismatch exists.

NVARRAY_GET_LONG Function

This function gets the value of the name-value array element that you specify in p_name and with the LONG_VALUE value type.

Syntax

DBMS_MGWMSG.NVARRAY_GET_LONG (
   p_array    IN SYS.MGW_NAME_VALUE_ARRAY_T,
   p_name     IN VARCHAR2,
   p_compare  IN BINARY_INTEGER DEFAULT CASE_SENSITIVE )
RETURN NUMBER;

Parameters

Table 32-17 NVARRAY_GET_LONG Function Parameters

Parameter	Description
`p_array`	The name-value array
`p_name`	The value name
`p_compare`	Name comparison method. Values: `CASE_SENSITIVE, CASE_INSENSITIVE`

Returns

The value, or NULL if the specified name is not found or if a type mismatch exists.

NVARRAY_GET_FLOAT Function

This function gets the value of the name-value array element that you specify in p_name and with the FLOAT_VALUE value type.

Syntax

DBMS_MGWMSG.NVARRAY_GET_FLOAT (
   p_array    IN SYS.MGW_NAME_VALUE_ARRAY_T,
   p_name     IN VARCHAR2,
   p_compare  IN BINARY_INTEGER DEFAULT CASE_SENSITIVE )
RETURN NUMBER;

Parameters

Table 32-18 NVARRAY_GET_FLOAT Function Parameters

Parameter	Description
`p_array`	The name-value array
`p_name`	The value name
`p_compare`	Name comparison method. Values: `CASE_SENSITIVE, CASE_INSENSITIVE`

Returns

The value, or NULL if the specified name is not found or if a type mismatch exists.

NVARRAY_GET_DOUBLE Function

This function gets the value of the name-value array element that you specify in p_name and with the DOUBLE_VALUE value type.

Syntax

DBMS_MGWMSG.NVARRAY_GET_DOUBLE (
   p_array    IN SYS.MGW_NAME_VALUE_ARRAY_T,
   p_name     IN VARCHAR2,
   p_compare  IN BINARY_INTEGER DEFAULT CASE_SENSITIVE )
RETURN NUMBER;

Parameters

Table 32-19 NVARRAY_GET_DOUBLE Function Parameters

Parameter	Description
`p_array`	The name-value array
`p_name`	The value name
`p_compare`	Name comparison method. Values: `CASE_SENSITIVE, CASE_INSENSITIVE`

Returns

The value, or NULL if the specified name is not found or if a type mismatch exists.

NVARRAY_GET_TEXT Function

This function gets the value of the name-value array element that you specify in p_name and with the TEXT_VALUE value type.

Syntax

DBMS_MGWMSG.NVARRAY_GET_TEXT (
   p_array    IN SYS.MGW_NAME_VALUE_ARRAY_T,
   p_name     IN VARCHAR2,
   p_compare  IN BINARY_INTEGER DEFAULT CASE_SENSITIVE )
RETURN VARCHAR2;

Parameters

Table 32-20 NVARRAY_GET_TEXT Function Parameters

Parameter	Description
`p_array`	The name-value array
`p_name`	The value name
`p_compare`	Name comparison method. Values: `CASE_SENSITIVE, CASE_INSENSITIVE`

Returns

The value, or NULL if the specified name is not found or if a type mismatch exists.

NVARRAY_GET_RAW Function

This function gets the value of the name-value array element that you specify in p_name and with the RAW_VALUE value type.

Syntax

DBMS_MGWMSG.NVARRAY_GET_RAW (
   p_array    IN SYS.MGW_NAME_VALUE_ARRAY_T,
   p_name     IN VARCHAR2,
   p_compare  IN BINARY_INTEGER DEFAULT CASE_SENSITIVE )
RETURN RAW;

Parameters

Table 32-21 NVARRAY_GET_RAW Function Parameters

Parameter	Description
`p_array`	The name-value array
`p_name`	The value name
`p_compare`	Name comparison method. Values: `CASE_SENSITIVE, CASE_INSENSITIVE`

Returns

The value, or NULL if the specified name is not found or if a type mismatch exists.

NVARRAY_GET_DATE Function

This function gets the value of the name-value array element that you specify in p_name and with the DATE_VALUE value type.

Syntax

DBMS_MGWMSG.NVARRAY_GET_DATE (
   p_array    IN SYS.MGW_NAME_VALUE_ARRAY_T,
   p_name     IN VARCHAR2,
   p_compare  IN BINARY_INTEGER DEFAULT CASE_SENSITIVE )
RETURN DATE;

Parameters

Table 32-22 NVARRAY_GET_DATE Function Parameters

Parameters	Description
`p_array`	The name-value array
`p_name`	The value name
`p_compare`	Name comparison method. Values: `CASE_SENSITIVE, CASE_INSENSITIVE`

Returns

The value, or NULL if the specified name is not found or if a type mismatch exists.

NVARRAY_FIND_NAME Function

This function searches a name-value array for the element with the name you specify in p_name.

Syntax

DBMS_MGWMSG.NVARRAY_FIND_NAME (
   p_array    IN SYS.MGW_NAME_VALUE_ARRAY_T,
   p_name     IN VARCHAR2,
   p_compare  IN BINARY_INTEGER DEFAULT CASE_SENSITIVE )
RETURN BINARY_INTEGER;

Parameters

Table 32-23 NVARRAY_FIND_NAME Function Parameters

Parameters	Description
`p_array`	The name-value array to search
`p_name`	The name to find
`p_compare`	Name comparison method. Values: `CASE_SENSITIVE, CASE_INSENSITIVE`

Returns

A positive integer that is the array index of the matching element
0 if the specified name is not found

NVARRAY_FIND_NAME_TYPE Function

This function searches a name-value array for an element with the name and value type you specify.

Syntax

DBMS_MGWMSG.NVARRAY_FIND_NAME_TYPE (
   p_array    IN SYS.MGW_NAME_VALUE_ARRAY_T,
   p_name     IN VARCHAR2,
   p_type     IN BINARY_INTEGER
   p_compare  IN BINARY_INTEGER DEFAULT CASE_SENSITIVE )
RETURN BINARY_INTEGER;

Parameters

Table 32-24 NVARRAY_FIND_NAME_TYPE Function Parameters

Parameter	Description
`p_array`	The name-value array to search
`p_name`	The name to find
`p_type`	The value type. Refer to the value type constants in Table 32-7 .
`p_compare`	Name comparison method. Values: `CASE_SENSITIVE, CASE_INSENSITIVE`

Returns

A positive integer that is the array index of the matching element
0 if the specified name is not found
-1 if the specified name is found but a type mismatch exists