Export (0) Print
Expand All

IAuthInfo::GetDomain 

This method is called when an HTTP authorization implementation requires a domain to access a protected URL.


HRESULT GetDomain( 
   LPTSTR szDomain, 
   DWORD *pdwBuffSize 
);

Parameters

szDomain

A pointer to the buffer where the IAuthInfo implementation class is to store the domain name.

pdwBuffSize

The address of a DWORD that, on entry, contains the size of the buffer provided as szDomain. Implementations of IAuthInfo should not exceed the buffer size when providing domain information. On exit, pdwBuffSize should contain the size of the domain name, including the NULL terminator.

An HRESULT indicating the success or failure of the call. Returns 0 if the domain name is successfully retrieved, otherwise nonzero.

The GetDomain method is typically called by a CAtlBaseAuthObject derived class that is attempting to satisfy the security requirements of a requested URL.

A domain name is not required for all authentication schemes. The BASIC scheme, for example, requires a user name and password, but not a domain name. As a result, the CBasicAuthObject class, ATL Server's implementation of the BASIC scheme, does not call the GetDomain method.

Community Additions

ADD
Show:
© 2014 Microsoft