DsMakePasswordCredentials function
The DsMakePasswordCredentials function constructs a credential handle suitable for use with the DsBindWithCred function.
Syntax
DWORD DsMakePasswordCredentials( _In_ LPCTSTR User, _In_ LPCTSTR Domain, _In_ LPCTSTR Password, _Out_ RPC_AUTH_IDENTITY_HANDLE *pAuthIdentity );
Parameters
- User [in]
-
Pointer to a null-terminated string that contains the user name to use for the credentials.
- Domain [in]
-
Pointer to a null-terminated string that contains the domain that the user is a member of.
- Password [in]
-
Pointer to a null-terminated string that contains the password to use for the credentials.
- pAuthIdentity [out]
-
Pointer to an RPC_AUTH_IDENTITY_HANDLE value that receives the credential handle. This handle is used in a subsequent call to DsBindWithCred. This handle must be freed with the DsFreePasswordCredentials function when it is no longer required.
Return value
Returns a Windows error code, including the following.
- ERROR_SUCCESS
-
The function succeeded.
- ERROR_INVALID_PARAMETER
-
User is invalid.
- ERROR_NOT_ENOUGH_MEMORY
-
A memory allocation failure occurred.
- STATUS_INVALID_PARAMETER
-
pAuthIdentity is invalid.
Remarks
A null, default credential handle is created if User, Domain and Password are all NULL. Otherwise, User must be present. The Domain parameter may be NULL when User is fully qualified, such as a user in UPN format; for example, "someone@fabrikam.com".
When the handle returned in pAuthIdentity is passed to DsBindWithCred, DsUnBind must be called before freeing the handle with DsFreePasswordCredentials. The normal sequence is:
- Call DsMakePasswordCredentials to obtain the credential handle.
- Call DsBindWithCred, and pass the credential handle.
- Call DsUnbind when the binding is no longer required.
- Call DsFreePasswordCredentials to free the credential handle.
Requirements
|
Minimum supported client |
Windows Vista |
|---|---|
|
Minimum supported server |
Windows Server 2008 |
|
Header |
|
|
Library |
|
|
DLL |
|
|
Unicode and ANSI names |
DsMakePasswordCredentialsW (Unicode) and DsMakePasswordCredentialsA (ANSI) |
See also
- DsBindWithCred
- DsFreePasswordCredentials
- DsUnbind
- RPC_AUTH_IDENTITY_HANDLE
- Domain Controller and Replication Management Functions