INetFwRule::Enabled property

Enables or disables a rule.

This property is read/write.

Syntax


HRESULT put_Enabled(
  [in]  VARIANT_BOOL enabled
);

HRESULT get_Enabled(
  [out] VARIANT_BOOL *enabled
);

Property value

Indicates whether the rule is enabled or disabled. If the rule must be enabled, this value must be set to true (VARIANT_TRUE).

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. A new rule is disabled by default.

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

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

 

 

Show: