Name

omX_object_to_string - Converts an OM object from descriptor to string format

Synopsis

#include <xom.h>
#include <xomext.h> OM_return_code omX_object_to_string(
OM_object object,
OM_boolean local_strings,
OM_string ∗string);

Parameters

Input

objectContains the OM object to be converted. 

local_stringsThis Boolean value indicates if the string return value should be converted to a local string format.  For further information on local strings please refer to the OSF DCE Application Development Guide—Directory Services. 

Output

stringContains the converted object in string format.  The calling function should provide the memory for string.  The string’s contents are initially unspecified.  The string’s length becomes the number of octets required to contain the segment that the function is to read.  The service modifies this parameter.  The string’s elements become the elements actually read.  The string’s length becomes the number of octets required to hold the segment actually read. 

Description

The omX_object_to_string() function converts an OM object into a string format.  The object can either be a client-generated or a service-generated public or private object. 

The objects that can be handled by this function are restricted to those defined in the schema file, xoischema.  Additionally, the OM objects DS_­C_­ATTRIBUTE_­ERROR and DS_­C_­ERROR are also handled.  For these, a message string containing the error message is returned. 

For the syntax of the output strings, please refer to the OSF DCE Application Development Guide—Directory Services. 

Return Values

The following describes a partial list of messages (or errors) that might be returned.  Refer to the OSF DCE Problem Determination Guide for complete descriptions of all error messages. 

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) and xomext.h for a list of the possible error values that can be returned in OM_return_code.  Refer to the OSF DCE Problem Determination Guide for complete descriptions of all error messages.