DsFreePasswordCredentials function

The DsFreePasswordCredentials function frees memory allocated for a credentials structure by the DsMakePasswordCredentials function.

Syntax

NTDSAPI VOID DsFreePasswordCredentials(
  RPC_AUTH_IDENTITY_HANDLE AuthIdentity
);

Parameters

AuthIdentity

Handle of the credential structure to be freed.

Return value

This function does not return a value.

Remarks

When the handle in AuthIdentity is passed to DsBindWithCred, DsUnbind must be called before freeing this handle. The normal sequence of events is:

  1. Call DsMakePasswordCredentials to obtain the credential handle.
  2. Call DsBindWithCred, passing the credential handle.
  3. Call DsUnbind when the RPC connection is no longer required.
  4. Call DsFreePasswordCredentials to free the credential handle.

Requirements

   
Minimum supported client Windows Vista
Minimum supported server Windows Server 2008
Target Platform Windows
Header ntdsapi.h
Library Ntdsapi.lib
DLL Ntdsapi.dll

See also

Domain Controller and Replication Management Functions

DsBindWithCred

DsMakePasswordCredentials

DsUnbind