om_copy_value(3xom) — Subroutines

Name

om_copy_value − Copies a value (string) from a private object and places it in another private object.

Syntax

OM_return_code om_copy_value(source, source_type, source_value_position, destination, destination_type, destination_value_position)

source@OM_private_object@T{ read T} source_type@OM_type@T{ read T} source_value_position@OM_value_position@T{ read T} destination@OM_private_object@T{ read T} destination_type@OM_type@T{ read T} destination_value_position@OM_value_position@T{ read T} return_code@T{ OM_return_code T}

C Binding

OM_return_code om_copy_value(source, source_type, source_value_position, destination, destination_type, destination_value_position)

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

Arguments

Source

The object from which you want to copy the value.

Source Type

The type of the attribute value from which you want to copy the value.

Source Value Position

The position within the attribute of the value to be copied.

Destination

The object to which you want to copy the value.

Destination Type

The type of the attribute to which you want to copy the value.

Destination Value Position

The position within the destination attribute at which you want to place the copied value. If the value of this argument exceeds the number of values in the Destination attribute, then it is taken to be equal to that number.

Description

This function either replaces, or fills in for the first time, an attribute value in the destination object with a copy of an attribute value from the source object. The source value should be a string. The copy has the same syntax as the source value.

Return Values

The function has completed its task successfully T} OM_FUNCTION_DECLINED@T{ The function does not apply to the object to which it is addressed T} OM_FUNCTION_INTERRUPTED@T{ The function was aborted by external intervention T} OM_MEMORY_INSUFFICIENT@T{ There is not enough memory to complete the function T} OM_NETWORK_ERROR@T{ The Service cannot use the underlying network T} OM_NO_SUCH_OBJECT@T{ You have specified a nonexistent object, or an invalid Handle for an object T} OM_NO_SUCH_TYPE@T{ There is an undefined type identifier T} OM_NOT_PRESENT@T{ An expected attribute value is missing T} OM_NOT_PRIVATE@T{ There is a public object where there should be a private object T} OM_PERMANENT_ERROR@T{ The Service encountered a permanent problem for which there is no defined error code T} OM_POINTER_INVALID@T{ An invalid pointer was supplied as a function argument or as the receptacle for a function result T} OM_SYSTEM_ERROR@T{ The Service cannot use the operating system T} OM_TEMPORARY_ERROR@T{ The Service encountered a temporary problem for which there is no defined error code T} OM_WRONG_VALUE_LENGTH@T{ There is an attribute with a value that violates the value length constraints in force T} OM_WRONG_VALUE_SYNTAX@T{ There is an attribute value with an illegal syntax T} OM_WRONG_VALUE_TYPE@T{ There is an attribute value of an illegal type T}

Examples

The following example shows the copying of a string value between two objects of the MH class Delivery Envelope (envelope1 and envelope2).

Exhibit 0-0.

OM_private_object    envelope1,
                     envelope2;

OM_return_code       result;

     result = om_copy_value (envelope1,
                                 /∗ source object ∗/
                             MH_T_CONTENT_IDENTIFIER,
                                 /∗ source attribute ∗/
                             0,
                                 /∗ position of value in source attribute ∗/
                            envelope2,
                                 /∗ destination object ∗/
                             MH_T_CONTENT_IDENTIFIER,
                                 /∗ destination attribute ∗/
                            0);
                                 /∗ position in destination attribute ∗/

This call to Copy Value reads the string value at position 0 in the Content Identifier attribute of envelope1. This value is then copied to position 0 in the Content Identifier attribute of envelope2.

Museum