Name

om_copy_value - Places or replaces a string in one private object with a copy of a string in another private object

Synopsis

#include <xom.h> OM_return_code  om_copy_value(
OM_private_object source,
OM_type source_type,
OM_value_position source_value_position,
OM_private_object destination,
OM_type destination_type,
OM_value_position destination_value_position);

Parameters

Input

sourceThe source that remains accessible. 

source_typeIdentifies the type of an attribute.  One of the attribute values is copied. 

source_value_position
The position within the source attribute of the value copied. 

destinationThe destination that remains accessible. 

destination_type
Identifies the type of the attribute.  One of the attribute values is placed or replaced.

destination_value_position
The position within the destination attribute of the value placed or replaced.  If the value position exceeds the number of values present in the destination attribute, the parameter is taken to be equal to that number. 

Description

The om_copy_value() function places or replaces an attribute value in one private object (the destination) with a copy of an attribute value in another private object (the source).  The source value is a string.  The copy’s syntax is that of the original. 

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 this reference page.  The exact constants for OM_return_code are defined in the xom.h header file (see the xom.h(4xom) reference page later in this chapter). 

Errors

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

       •OM_FUNCTION_DECLINED

       •OM_FUNCTION_INTERRUPTED

       •OM_MEMORY_INSUFFICIENT

       •OM_NETWORK_ERROR

       •OM_NO_SUCH_OBJECT

       •OM_NO_SUCH_TYPE

       •OM_NOT_PRESENT

       •OM_NOT_PRIVATE

       •OM_PERMANENT_ERROR

       •OM_POINTER_INVALID

       •OM_SYSTEM_ERROR

       •OM_TEMPORARY_ERROR

       •OM_WRONG_VALUE_LENGTH

       •OM_WRONG_VALUE_SYNTAX

       •OM_WRONG_VALUE_TYPE