om_delete(3xom) — Subroutines

Name

om_delete − Deletes a service-generated public object or makes a private object inaccessible.

Syntax

OM_return_code om_delete(subject)

subject@OM_object@T{ read T} return_code@T{ OM_return_code T}

C Binding

OM_return_code om_delete(subject)

OM_object subject

Arguments

Subject

The object that you want the Service to delete. It must be a service-generated public object or a private object. If the object that you specify is a client-generated public object, the function returns an error status.

Description

This function deletes a service-generated public object, or makes a private object inaccessible.

When you apply this function to a service-generated public object, the function deletes the object and releases the resources associated with it. The resources include the space occupied by descriptors and attribute values. The function also deletes all public subobjects of the subject. This function does not delete private subobjects.

When you apply this function to a private object, the function makes the object inaccessible by making its Handle invalid. The function also makes invalid the Handles of any private subobjects of the subject. Note that the effect of using an object’s Handle once it has been made invalid is undefined.

Return Values

The function has completed its task successfully 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_SYNTAX@T{ There is an undefined syntax identifier T} OM_NO_SUCH_TYPE@T{ There is an undefined type identifier T} OM_NOT_THE_SERVICES@T{ There is an object that is Client generated when it should be Service generated or private 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 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}

Examples

The following example shows how to delete a service-generated public object of the X.500 class Entry-Info-Selection (info_select_copy). The object is a public copy of a private object of class Entry-Info-Selection info_select.

Exhibit 0-0.

OM_return_code      result;

OM_private_object   info_select;

OM_object           info_select_copy;

OM_value_position   total_number;

     result = om_get (info_select,
                             /∗ object to be copied ∗/
                      OM_NO_EXCLUSIONS,
                             /∗ no exclusions ∗/
                      NULL,
                             /∗ ignored because no exclusions specified ∗/
                      OM_FALSE,0,0,
                             /∗ no translation into local char set ∗/
                      &info_select_copy,
                             /∗ the copy ∗/
                      &total_number);
                             /∗ number of attributes copied ∗/

/∗ Examine info_select_copy public object using C programming language constructs ∗/

/∗ Delete object when finished with it ∗/

     result = om_delete (info_select_copy);
                             /∗ the object to be deleted ∗/

Museum