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 |
|---|---|
|
The operation was aborted. |
|
An unspecified error occurred. |
|
One of the parameters is invalid. |
|
A specified interface is not supported. |
|
A specified method is not implemented. |
|
The method was unable to allocate required memory. |
|
A pointer passed as a parameter is not valid. |
|
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 |