DsBindWithCredA function (ntdsapi.h)
The DsBindWithCred function binds to a domain controller using the specified credentials.
Syntax
NTDSAPI DWORD DsBindWithCredA(
[in, optional] LPCSTR DomainControllerName,
[in, optional] LPCSTR DnsDomainName,
[in, optional] RPC_AUTH_IDENTITY_HANDLE AuthIdentity,
[out] HANDLE *phDS
);
Parameters
[in, optional] DomainControllerName
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.
[in, optional] DnsDomainName
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.
[in, optional] AuthIdentity
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.
[out] phDS
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.
Remarks
Note
The ntdsapi.h header defines DsBindWithCred as an alias which automatically selects the ANSI or Unicode version of this function based on the definition of the UNICODE preprocessor constant. Mixing usage of the encoding-neutral alias with code that not encoding-neutral can lead to mismatches that result in compilation or runtime errors. For more information, see Conventions for Function Prototypes.
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client | Windows Vista |
| Minimum supported server | Windows Server 2008 |
| Target Platform | Windows |
| Header | ntdsapi.h |
| Library | Ntdsapi.lib |
| DLL | Ntdsapi.dll |