NAME

omX_fill - Initializes an OM_descriptor structure

SYNOPSIS

#include <xom.h>
#include <xomext.h>

OM_return_code omX_fill(
        OM_type type,
        OM_syntax syntax,
        OM_uint32 length,
        void *elements,
        OM_descriptor *destination);

PARAMETERS

Input

type: The type of OM descriptor structure.
syntax: The syntax value for this OM descriptor.
length: The data length for values of string syntax. Zero is entered for values of type OM_object. When initializing an OM_descriptor with an OM_type that has an OM_syntax of either OM_S_INTEGER, OM_S_BOOLEAN or OM_S_ENUMERATION, then the associated value must be entered in the length parameter.
elements: The string contents.

Output

destination: Contains the filled descriptor.

DESCRIPTION

The omX_fill() function is used to initialize an OM descriptor structure with user supplied values for its type, syntax, and value.

RETURN VALUES

OM_return_code: Indicates whether the function succeeded and, if not, why not. If the function is successful, the value of OM_return_code is set to OM_SUCCESS; if the function fails, it has one of the error values listed in the xom.h(4xom) reference page.

ERRORS

Refer to xom.h(4xom) for a list of the possible error values that can be returned in OM_return_code.