Name

ds_unbind - Unbinds from a directory session

Synopsis

#include <xom.h>
#include <xds.h> DS_status ds_unbind(
OM_private_object session);

Parameters

Input

session(Object(DS_C_SESSION)).  The directory session to be unbound.  This must be a private object.  The value of the DS_FILE_DESCRIPTOR OM attribute is DS_­NO_­VALID_­FILE_­DESCRIPTOR if the function succeeds.  The remaining OM attributes are unchanged. 

Description

The ds_unbind() function terminates the given directory session and makes the parameter unavailable for use with other interface functions (except ds_bind()). 

The unbound session can be used again as a parameter to ds_bind() possibly after modification by the OM functions.  When it is no longer required, it must be deleted by using the OM functions. 

Return Values

DS_statusTakes the value DS_SUCCESS if the session parameter is unbound and takes an error value if not. 

Errors

The following describes a partial list of errors that might be returned.  Refer to the OSF DCE Problem Determination Guide for complete descriptions of all error messages. 

This function can return a DS_C_SYSTEM_ERROR or one of the following DS_C_LIBRARY_ERROR errors:

       •DS_E_BAD_SESSION

       •DS_E_MISCELLANEOUS

If ds_unbind() is called while there are outstanding directory operations (from other threads), then this function will return a DS_SERVICE_ERROR with the value DS_E_BUSY. 

This function does not return a DS_C_COMMUNICATIONS_ERROR or any directory errors.  However, this function can return the error constant DS_NO_WORKSPACE. 

Related Information

Functions: ds_bind(3xds).