INetFwRules::Item method (netfw.h)

The Item method returns the specified rule if it is in the collection.

Syntax

HRESULT Item(
  [in]  BSTR       name,
  [out] INetFwRule **rule
);

[in] name

Name of the rule to retrieve.

[out] rule

Reference to the returned INetFwRule object.

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.
E_POINTER	The method failed due to an invalid pointer.
HRESULT_FROM_WIN32(ERROR_FILE_NOT_FOUND)	The requested item does not exist.

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.
E_POINTER	The method failed due to an invalid pointer.
HRESULT_FROM_WIN32(ERROR_FILE_NOT_FOUND)	The requested item does not exist.

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