cwbUN_GetLdapSvrSuffixName

Purpose

Returns the distinguished name of the suffix.

Syntax

int cwbUN_GetLdapSuffixNameA
    ( cwbUN_ldapSvrHandle      handle,
      int                      index,
      LPSTR                    suffix,
      int                      *length
    );
 
int cwbUN_GetLdapSuffixNameW
    ( cwbUN_ldapSvrHandle      handle,
      int                      index,
      LPWSTR                   suffix,
      int                      *length
    );
 
int cwbUN_GetLdapSuffixName8 /* returns suffix in UTF-8 */
    ( cwbUN_ldapSvrHandle      handle,
      int                      index,
      LPSTR                    suffix,
      int                      *length
    );

Parameters

cwbUN_ldapSuffixHandle handle - input

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

int index - input

Zero-based index of the suffix. This value must be less than the count returned by cwbUN_GetLdapSvrSuffixCount().

LPSTR suffix - output

Pointer to the buffer that will contain the distinguished name of the suffix.

int * length - input/output

Pointer to the length of the suffix 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