ds_shutdown(3xds) — Subroutines

Name

ds_shutdown − Shuts down the interface and closes the workspace.

Syntax

Status = ds_shutdown(Workspace)

Argument@Data Type@Access

Workspace@OM_workspace@T{ read T} Status@T{ DS_status T}

C Binding

DS_status ds_shutdown(workspace)

OM_workspace@T{ workspace T}

Arguments

Workspace

Specifies the workspace (obtained from a call to the Initialize function) that is to be deleted.

Description

This function shuts down the interface previously established by Initialize and enables the service to release resources.

After this function has been called, no OM objects or other data values associated with the workspace are valid, with the exception of client-generated public objects. You should call the Unbind function for all sessions in this workspace. You must not subsequently call any X.500 API functions that operate on OM objects in this workspace.

In order to ensure that resources are freed, applications should release all private objects by calling the OM Delete function for all top-level OM private objects before calling this function. This is not necessary for subobjects. Applications should also release all service-generated public objects by calling the OM Delete function. You can do this either before or after the calling of this function.

Return Value

The shutdown was completed, if the operation was invoked synchronously. The operation was initiated, if it was invoked asynchronously. T} DS_NO_WORKSPACE@T{ A workspace has not been set up by a call to the Initialize function. T}

Errors

This function does not return any error objects.

Example

The following code extract shows an example call to the Shutdown function:

Exhibit 0-0.

OM_workspace workspace;

{
DS_status status;

/∗ Finally, close down the workspace ∗/

ds_status = ds_shutdown(workspace);

}

The Shutdown function closes down the workspace identified in the Workspace argument. The workspace identity is obtained from the Initialize function.

Museum