IStaticPortMappingCollection::get_Item method (natupnp.h)

The get_Item method retrieves the specified port mapping from the collection.

Syntax

HRESULT get_Item(
  [in]  long               lExternalPort,
  [in]  BSTR               bstrProtocol,
  [out] IStaticPortMapping **ppSPM
);

Parameters

[in] lExternalPort

Specifies the external port for this port mapping.

[in] bstrProtocol

Specifies the protocol. This parameter should be either UDP or TCP.

[out] ppSPM

Pointer to an interface pointer that points to an IStaticPortMapping interface for this port mapping.

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.

Remarks

The NAT API with UPnP technology uses the combination of the external port and the protocol to identify the port mapping.

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

BSTR

IStaticPortMapping

IStaticPortMappingCollection

Network Address Translation Traversal Interfaces

Network Address Translation Traversal Reference