ds_unbind(3xds) — Subroutines

Name

ds_unbind − This function closes a directory session.

Syntax

Status = ds_unbind(Session)

Argument@Data Type@Access

Session@OM_private_object@T{ read T} Status@T{ DS_status T}

C Binding

DS_status ds_unbind (session)

OM_private_object@T{ session T}

Arguments

Session

The directory session that is to be unbound. This argument must be the Session OM private object that was returned by the Bind function, identifying the directory session. If the function succeeds, the value of the File-Descriptor OM attribute is No-Valid-File-Descriptor. The other OM attributes are unchanged.

Description

This function terminates the given directory session and makes the argument unavailable for use with all other interface functions except Bind.

The results of any outstanding asynchronous operations that were initiated using the given Session can no longer be received, and it is not possible to find out if they succeeded. It is therefore recommended that you obtain the results of all outstanding asynchronous operations by calling the Receive-Result function before calling Unbind.

It is possible to use the unbound session again as an argument to Bind, perhaps after modification by the Object Management functions.

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 object:

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

Example

The following code extract shows an example call to the Unbind function.

Exhibit 0-0.

{
OM_private_object bound_session;
DS_status         status;

status = ds_unbind(bound_session);

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

The Unbind function closes down a session established by the Bind function. The Bound_Session argument identifies the session to be closed.

Museum