Export (0) Print
Expand All

INetFwRule::Grouping property

Specifies the group to which an individual rule belongs.

This property is read/write.

Syntax


HRESULT put_Grouping(
  [in]   BSTR context
);

HRESULT get_Grouping(
  [out]  BSTR *context
);

Property value

The group to which the rule belongs.

Error codes

If the method succeeds, the return value is S_OK.

If the method fails, the return value is one of the following error codes.

NameMeaning
E_ACCESSDENIED

The operation was aborted due to permissions issues.

E_INVALIDARG

The method failed due to an invalid parameter.

E_OUTOFMEMORY

The method was unable to allocate required memory.

E_POINTER

The method failed due to an invalid pointer.

Remarks

This property is optional.

Also see the restrictions on changing properties described in the Remarks section of the INetFwRule interface page.

Using the Grouping property is highly recommended, as it groups multiple rules into a single line in the Windows Firewall control panel. This allows the user to enable or disable multiple rules with a single click. The Grouping property can also be specified using indirect strings. In this case, a group description can also be specified that will appear in the rule group properties in the Windows Firewall control panel. For example, if the group string is specified by an indirect string at index 1005 ("@yourresources.dll,-1005"), the group description can be specified at a resource string higher by 10000 "@youresources.dll,-11005."

When indirect strings in the form of "h" are passed as parameters to the Windows Firewall with Advanced Security APIs, they should either be placed under the System32 Windows directory or specified by a full path. Further, the file should have a secure access that permits the Local Service account read access to allow the Windows Firewall Service to read the strings. To avoid non-privileged security principals from modifying the strings, the DLLs should only allow write access to the Administrator account.

Requirements

Minimum supported client

Windows Vista [desktop apps only]

Minimum supported server

Windows Server 2008 [desktop apps only]

Header

Netfw.h

DLL

FirewallAPI.dll

See also

INetFwRule

 

 

Community Additions

ADD
Show:
© 2014 Microsoft