Edit

Share via

IHttpServer2::GetToken Method

  • Article

Retrieves an authentication token given a user name, password, and login method.

Syntax

virtual HRESULT GetToken(  
   _In_ PCWSTR                     pszUserName,  
   _In_ PCWSTR                     pszPassword,  
   _In_ DWORD                      dwLogonMethod,   _Outptr_ IHttpTokenEntry **      ppTokenEntry,  
   _In_opt_ PCWSTR                 pszDefaultDomain = NULL,  
   _In_opt_ PSOCKADDR              pSockAddr = NULL,  
   _In_opt_ IHttpTraceContext *    pHttpTraceContext = NULL  
) = 0;

Parameters

pszUserName
[IN] Points to the user name.

pszPassword
[IN] Points to the password.

dwLogonMethod
[IN] The logon method.

ppTokenEntry
[OUT] Points to the IHttpTokenEntry interface that represents the token.

pszDefaultDomain
[IN] Optional default domain name.

pSockAddr
[IN] Optional socket address.

pHttpTraceContext
[IN] Optional pointer to an IHttpTraceContext interface.

Return Value

An HRESULT. Possible values include, but are not limited to, those in the following table.

Value Description
S_OK Indicates that the operation was successful.

Requirements

Type Description
Client - IIS 7.0 on Windows Vista
- IIS 7.5 on Windows 7
- IIS 8.0 on Windows 8
- IIS 10.0 on Windows 10
Server - IIS 7.0 on Windows Server 2008
- IIS 7.5 on Windows Server 2008 R2
- IIS 8.0 on Windows Server 2012
- IIS 8.5 on Windows Server 2012 R2
- IIS 10.0 on Windows Server 2016
Product - IIS 7.0, IIS 7.5, IIS 8.0, IIS 8.5, IIS 10.0
- IIS Express 7.5, IIS Express 8.0, IIS Express 10.0
Header Httpserv.h

See Also

IHttpServer2 Interface