IFWXAuthenticatedUser::Username property

Article
08/27/2012

Applies to: desktop apps only

The Username property gets the name of the authenticated user.

This property is read-only.

Syntax

HRESULT get_Username(
  [out]  BSTR *pbstrUsername
);

Property value

Pointer to a BSTR that is set on return to a string value specifying the name of the authenticated user.

Error codes

This property method returns S_OK if the call is successful; otherwise, it returns an error code.

Remarks

Memory is allocated by the Microsoft Firewall service, which implements the Username property. The caller should free the memory using SysFreeString. For recommendations on memory allocation for BSTR strings, see Best Practices.

Requirements

Minimum supported client	None supported
Minimum supported server	Windows Server 2008 R2, Windows Server 2008 with SP2 (64-bit only)
Version	Forefront Threat Management Gateway (TMG) 2010
Header	Wspfwext.idl
DLL	Wspsrv.exe