DsBindWithCred function (Windows)

Applies to: desktop apps only

The DsBindWithCred function binds to a domain controller using the specified credentials.

Syntax

DWORD DsBindWithCred(
  __in_opt  LPCTSTR DomainControllerName,
  __in_opt  LPCTSTR DnsDomainName,
  __in_opt  RPC_AUTH_IDENTITY_HANDLE AuthIdentity,
  __out     HANDLE *phDS
);

Parameters

DomainControllerName [in, optional]

Pointer to a null-terminated string that contains the fully qualified DNS name of the domain to bind. For more information about this parameter, see the DomainControllerName description in the DsBind topic.

DnsDomainName [in, optional]

Pointer to a null-terminated string that contains the fully qualified DNS name of the domain to bind to. For more information about this parameter, see the DnsDomainName description in the DsBind topic.

This parameter is required to secure a Kerberos authentication.

AuthIdentity [in, optional]

Contains an RPC_AUTH_IDENTITY_HANDLE value that represents the credentials to be used for the bind. The DsMakePasswordCredentials function is used to obtain this value. If this parameter is NULL, the credentials of the calling thread are used.

DsUnBind must be called before freeing this handle with the DsFreePasswordCredentials function.

phDS [out]

Address of a HANDLE value that receives the binding handle. To close this handle, pass it to the DsUnBind function.

Return value

Returns ERROR_SUCCESS if successful or a Windows or RPC error code otherwise. The following are the most common error codes.

Requirements

See also

DOMAIN_CONTROLLER_INFO

DsBind

DsGetDcName

DsMakePasswordCredentials

DsUnBind

DsFreePasswordCredentials

Mutual Authentication Using Kerberos

Domain Controller and Replication Management Functions

Send comments about this topic to Microsoft

Build date: 2/3/2012