Edit

INetFwRules::Remove method (netfw.h)

  • Article

The Remove method removes a rule from the collection.

Syntax

HRESULT Remove(
  [in] BSTR name
);

Parameters

[in] name

Name of the rule to remove from the collection.

Return value

C++

If the method succeeds the return value is S_OK.

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

Return code Description
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.
 

VB

If the method succeeds the return value is S_OK.

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

Return code Description
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.

Remarks

If a rule specified by the name parameter does not exist in the collection, the Remove method has no effect.

Requirements

Requirement Value
Minimum supported client Windows Vista [desktop apps only]
Minimum supported server Windows Server 2008 [desktop apps only]
Target Platform Windows
Header netfw.h
DLL FirewallAPI.dll

See also

INetFwRules