ct_ds_dropobj

Description

Release the memory associated with a directory object.

Syntax

CS_RETCODE ct_ds_dropobj(connection, ds_object)
 
 CS_CONNECTION   *connection;
 CS_DS_OBJECT      *ds_object;

Parameters

connection: A pointer to a CS_CONNECTION structure. ct_ds_lookup returns search results to the application’s directory callback that has been installed in the CS_CONNECTION structure.

ds_object: A pointer to the directory object being discarded.

Returns

ct_ds_dropobj returns the following values:

Return value	Meaning
CS_SUCCEED	The routine succeeded.
CS_FAIL	The routine failed.

Usage

ct_ds_dropobj discards a CS_DS_OBJECT hidden structure and frees the memory associated with it. The directory entry associated with the object is not affected in any way by ct_ds_dropobj.

To keep the information associated with a directory object, copy it into application memory before dropping the object.

If an application does not explicitly drop directory objects with ct_ds_dropobj, Client-Library drops them automatically when the application calls ct_con_drop to drop the parent connection.