NAME

SYNOPSIS

#include <xom.h>
#include <xds.h>
#include <xdsext.h>

OM_return_code dsX_extract_attr_values(
        OM_private_object object,
        OM_object_identifier attribute_type,
        OM_boolean local_strings,
        OM_public_object *values,
        OM_value_position *total_number);

PARAMETERS

Input

object

The private object from which the attribute values are to be extracted. Objects of type DS_C_ATTRIBUTE_LIST or DS_C_ENTRY_INFO are supported.

attribute_type

The attribute type from which the values are to extracted.

local_strings

Indicates if results should be converted to a local string format. For further information on local strings please refer to Chapter 10 of the OSF DCE Application Development Guide.

Output

values

The values parameter is only present if the return value from OM_return_code is OM_SUCCESS. It points to a public object containing an array of OM descriptors with the extracted attribute values.

total_number

Contains the total number of attribute values that have been extracted.

Note that the total includes only the attribute descriptors in the values parameter. It excludes the special descriptor signaling the end of a public object.

DESCRIPTION

The dsX_extract_attr_values() function is used to extract the attribute values associated with the specified attribute type from an OM object. The OM object must be of type DS_C_ATTRIBUTE_LIST or DS_C_ENTRY_INFO. It returns an object containing an array of OM descriptors.

NOTES

The memory space for the values return parameter is allocated by dsX_extract_attr_values(). The calling application is responsible for releasing this memory with the om_delete() function call.

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 possible error values that can be returned in OM_return_code.