UserGroups Property of the IFWXAuthenticatedUser Interface

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

HRESULT get_UserGroups(
  [out]  BSTR* pbstrUserGroups
);

Parameters

pbstrUserGroups

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.

Return Value

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

Server	Requires Windows Server 2008.
Version	Requires Forefront Threat Management Gateway (TMG).
Header	Declared in Wspfwext.idl.
DLL	Requires Wspsrv.exe.

See Also

IFWXAuthenticatedUser

Send comments about this topic to Microsoft

Build date: 11/30/2009