IFWXAuthenticatedUser::UserGroups property

Article
08/27/2012

Applies to: desktop apps only

The UserGroups property gets a semicolon delimited string detailing the groups to which the user belongs.

This property is read-only.

Syntax

HRESULT get_UserGroups(
  [out]  BSTR *pbstrUserGroups
);

Property value

Pointer to a BSTR that is set on return to a string value specifying a semicolon delimited string detailing the groups to which the user belongs.

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 UserGroups property. The caller should free the memory using SysFreeString. For recommendations on memory allocation for BSTR strings, see Best Practices.

Note User group information may not always be available, and is specifically unavailable for Windows users. For a Windows user, this method will return E_NOTIMPL.

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