ds_abandon(3xds) — Subroutines

Name

ds_abandon − This function abandons an outstanding asynchronous operation.

Syntax

Status = ds_abandon(Session, Invoke-ID)

Argument@Data Type@Access

Session@OM_private_object@T{ read T} Invoke-ID@Integer@T{ read T} Status@T{ DS_status T}

C Binding

DS_status ds_abandon(session, invoke_id)

OM_private_object@T{ session T} OM_sint@T{ invoke_id T}

Arguments

Session

The Session OM private object that was returned by the Bind function, identifying the directory session in which the operation was submitted to the directory.

Invoke-ID

Identifies the operation that is to be abandoned.

The value of Invoke-ID must be that which was returned by the function call that initiated the asynchronous directory operation that is now to be abandoned.

Description

This function abandons the outstanding asynchronous function call. The asynchronous function is no longer outstanding after the Abandon function returns, and the results of the asynchronous function will never be returned by the Receive-Result function, even if the function returns an error.

DCE Notes

The DCE XDS interface does not support asynchronous operations.

Return Value

The operation completed successfully. T} DS_NO_WORKSPACE@T{ A workspace has not been set up by a call to the Initialize function. T}

If neither of these constants are returned, then the function returns a pointer to an error object of one of the classes listed below.

Errors

This function can return pointers to the following error objects:

Abandon-Failed

Communications-Error

Library-Error, with Problem attribute values of bad-session, or miscellaneous

The result of the asynchronous operation will not be returned even if an Abandon-Failed error is returned.

Example

The following code extract shows an example call to the Abandon function. The abandon function abandons the results of the asynchronous operation identified by the Invoke-ID argument.

Exhibit 0-0.

OM_private_object bound_session;

OM_sint            invoke_id;

{   DS_status      status;

    status = ds_abandon(bound_session, invoke_id);

    if (status == DS_SUCCESS)
    {
    printf("ABANDON was successful0);
    }
    else
    {
    printf("ABANDON failed0);
    }

}

Museum