Edit

IStaticPortMapping::Enable method (natupnp.h)

  • Article

The Enable method enables or disables this port mapping.

Syntax

HRESULT Enable(
  [in] VARIANT_BOOL vb
);

Parameters

[in] vb

Specifies a value that indicates whether the port mapping should be enabled or disabled. To enable the port mapping specify VARIANT_TRUE. To disable the port mapping specify VARIANT_FALSE.

Return value

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_ABORT
 The operation was aborted.
E_FAIL
 An unspecified error occurred.
E_INVALIDARG
 One of the parameters is invalid.
E_NOINTERFACE
 A specified interface is not supported.
E_NOTIMPL
 A specified method is not implemented.
E_OUTOFMEMORY
 The method was unable to allocate required memory.
E_POINTER
 A pointer passed as a parameter is not valid.
E_UNEXPECTED
 The method failed for unknown reasons.

Requirements

Requirement Value
Minimum supported client Windows XP [desktop apps only]
Minimum supported server Windows Server 2003 [desktop apps only]
Target Platform Windows
Header natupnp.h
DLL Hnetcfg.dll

See also

IStaticPortMapping

IStaticPortMapping::get_InternalEnabled

Network Address Translation Traversal Interfaces

Network Address Translation Traversal Reference