Microsoft Internet Security and Acceleration Server 2004 SDK

UserGroups Property of IFWXAuthenticatedUser

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

HRESULT get_UserGroups(
  BSTR* pbstrUserGroups
);

Parameters

pbstrUserGroups
[out] 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 Values

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 2003 or Windows 2000.
Version: Requires Internet Security and Acceleration Server 2004.
Header: Declared in Wspfwext.idl.

See Also

IFWXAuthenticatedUser