IStaticPortMapping::get_Enabled method (natupnp.h)

The get_Enabled method retrieves whether the port mapping is enabled.

Syntax

HRESULT get_Enabled(
  [out] VARIANT_BOOL *pVal
);

Parameters

[out] pVal

Pointer to a VARIANT_BOOL that receives a value that indicates whether the port mapping is enabled. The value is VARIANT_TRUE if the port mapping is enabled, VARIANT_FALSE otherwise.

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

   
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::Enabled

Network Address Translation Traversal Interfaces

Network Address Translation Traversal Reference