cwbUN_GetLdapPublishParentDn

Purpose

Returns the parent distinguished name of the published objects. For example, if the parentDN for publishing users was cn=users,o=ace industry,c=us, and user information was published for John Smith, the dn of the published object could be cn=john smith,cn=users,ou=ace industry,c=us.

Syntax

int cwbUN_GetLdapPublishParentDnW
    ( cwbUN_ldapPubHandle  handle,
      int                  index,
      LPWSTR               parentDn,
      int                  *length
    );
 
int cwbUN_GetLdapPublishParentDnA
    ( cwbUN_ldapPubHandle  handle,
      int                  index,
      LPSTR                parentDn,
      int                  *length
    );
 
int cwbUN_GetLdapPublishParentDn8 /* return parentDn in UTF-8 */
    ( cwbUN_ldapPubHandle  handle,
      int                  index,
      LPSTR                parentDn,
      int                  *length
    );

Parameters

cwbUN_ldapPubHandle handle - input

A handle previously obtained by a call to cwbUN_OpenLdapPublishing().

int index - input

Zero-based index of the publish record. This value must be less than the count returned by cwbUN_GetLdapPublishCount().

LPSTR parentDn - output

Pointer to the buffer that will contain the name of the parentDn.

int * length - input/output

Pointer to the length of the parentDn buffer. If the buffer is too small to hold the string, including space for the terminating NULL, the size of the buffer needed will be filled into this parameter.

Return Codes

The following list shows common return values:

CWB_OK

Successful completion.

CWB_INVALID_API_HANDLE

Invalid handle.

CWB_INVALID_API_PARAMETER

Invalid index.

CWB_INVALID_POINTER

A NULL pointer was specified.

CWB_BUFFER_OVERFLOW

The suffix buffer is not large enough to hold the entire result.

Usage

None