XboxLiveEndpointPairTemplate.CreateEndpointPairForPortsAsync Method

Definition

Namespace:

Windows.Networking.XboxLive

Overloads

CreateEndpointPairForPortsAsync(XboxLiveDeviceAddress, String, String)

Creates an endpoint pair between the local device and the specified remote device, specifying specific ports from the template's designated range of acceptable ports, with creation behavior XboxLiveEndpointPairCreationBehaviors.None. Important This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime.

CreateEndpointPairForPortsAsync(XboxLiveDeviceAddress, String, String, XboxLiveEndpointPairCreationBehaviors)

Creates an endpoint pair between the local device and the specified remote device, specifying specific ports from the template's designated ranges of acceptable ports, and specifying how the system should behave if an XboxLiveEndpointPair already exists for this template, remote device, and port combination. Important This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime.

CreateEndpointPairForPortsAsync(XboxLiveDeviceAddress, String, String)

Creates an endpoint pair between the local device and the specified remote device, specifying specific ports from the template's designated range of acceptable ports, with creation behavior XboxLiveEndpointPairCreationBehaviors.None.

Important

This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime.

public:
 virtual IAsyncOperation<XboxLiveEndpointPairCreationResult ^> ^ CreateEndpointPairForPortsAsync(XboxLiveDeviceAddress ^ deviceAddress, Platform::String ^ initiatorPort, Platform::String ^ acceptorPort) = CreateEndpointPairForPortsAsync;

/// [Windows.Foundation.Metadata.DefaultOverload]
/// [Windows.Foundation.Metadata.Overload("CreateEndpointPairForPortsDefaultAsync")]
/// [Windows.Foundation.Metadata.RemoteAsync]
IAsyncOperation<XboxLiveEndpointPairCreationResult> CreateEndpointPairForPortsAsync(XboxLiveDeviceAddress const& deviceAddress, winrt::hstring const& initiatorPort, winrt::hstring const& acceptorPort);

[Windows.Foundation.Metadata.DefaultOverload]
[Windows.Foundation.Metadata.Overload("CreateEndpointPairForPortsDefaultAsync")]
[Windows.Foundation.Metadata.RemoteAsync]
public IAsyncOperation<XboxLiveEndpointPairCreationResult> CreateEndpointPairForPortsAsync(XboxLiveDeviceAddress deviceAddress, string initiatorPort, string acceptorPort);

function createEndpointPairForPortsAsync(deviceAddress, initiatorPort, acceptorPort)

Public Function CreateEndpointPairForPortsAsync (deviceAddress As XboxLiveDeviceAddress, initiatorPort As String, acceptorPort As String) As IAsyncOperation(Of XboxLiveEndpointPairCreationResult)

Parameters

deviceAddress

XboxLiveDeviceAddress

The XboxLiveDeviceAddress of the remote device to be connected to.

initiatorPort

String

Platform::String

winrt::hstring

The port to be used by the initiator, from the range of acceptable initiator ports specified in this template.

acceptorPort

String

Platform::String

winrt::hstring

The port to be used by the acceptor, from the range of acceptable acceptor ports specified in this template.

Returns

IAsyncOperation<XboxLiveEndpointPairCreationResult>

An asynchronous endpoint creation operation. When the operation completes, contains the results of the operation.

Attributes

DefaultOverloadAttribute OverloadAttribute RemoteAsyncAttribute

See also

• CreateEndpointPairForPortsAsync(XboxLiveDeviceAddress, String, String, XboxLiveEndpointPairCreationBehaviors)

CreateEndpointPairForPortsAsync(XboxLiveDeviceAddress, String, String, XboxLiveEndpointPairCreationBehaviors)

Creates an endpoint pair between the local device and the specified remote device, specifying specific ports from the template's designated ranges of acceptable ports, and specifying how the system should behave if an XboxLiveEndpointPair already exists for this template, remote device, and port combination.

Important

This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime.

public:
 virtual IAsyncOperation<XboxLiveEndpointPairCreationResult ^> ^ CreateEndpointPairForPortsAsync(XboxLiveDeviceAddress ^ deviceAddress, Platform::String ^ initiatorPort, Platform::String ^ acceptorPort, XboxLiveEndpointPairCreationBehaviors behaviors) = CreateEndpointPairForPortsAsync;

/// [Windows.Foundation.Metadata.DefaultOverload]
/// [Windows.Foundation.Metadata.Overload("CreateEndpointPairForPortsWithBehaviorsAsync")]
/// [Windows.Foundation.Metadata.RemoteAsync]
IAsyncOperation<XboxLiveEndpointPairCreationResult> CreateEndpointPairForPortsAsync(XboxLiveDeviceAddress const& deviceAddress, winrt::hstring const& initiatorPort, winrt::hstring const& acceptorPort, XboxLiveEndpointPairCreationBehaviors const& behaviors);

[Windows.Foundation.Metadata.DefaultOverload]
[Windows.Foundation.Metadata.Overload("CreateEndpointPairForPortsWithBehaviorsAsync")]
[Windows.Foundation.Metadata.RemoteAsync]
public IAsyncOperation<XboxLiveEndpointPairCreationResult> CreateEndpointPairForPortsAsync(XboxLiveDeviceAddress deviceAddress, string initiatorPort, string acceptorPort, XboxLiveEndpointPairCreationBehaviors behaviors);

function createEndpointPairForPortsAsync(deviceAddress, initiatorPort, acceptorPort, behaviors)

Public Function CreateEndpointPairForPortsAsync (deviceAddress As XboxLiveDeviceAddress, initiatorPort As String, acceptorPort As String, behaviors As XboxLiveEndpointPairCreationBehaviors) As IAsyncOperation(Of XboxLiveEndpointPairCreationResult)

Parameters

deviceAddress

XboxLiveDeviceAddress

The XboxLiveDeviceAddress of the remote device to be connected to.

initiatorPort

String

Platform::String

winrt::hstring

The port to be used by the initiator, from the range of acceptable initiator ports specified in this template.

acceptorPort

String

Platform::String

winrt::hstring

The port to be used by the acceptor, from the range of acceptable acceptor ports specified in this template.

behaviors

XboxLiveEndpointPairCreationBehaviors

A value that specifies how the system should act when the requested endpoint pair has already been established. Your code can specify either that the existing XboxLiveEndpointPair be used, or that the system re-evaluate all potential network paths according to the template's quality requirements. If the same network path is selected after re-evaluation, then the same XboxLiveEndpointPair is returned. If a new path is found, then the old XboxLiveEndpointPair is destroyed, and a new one returned.

Returns

IAsyncOperation<XboxLiveEndpointPairCreationResult>

An asynchronous endpoint creation operation. When the operation completes, contains the results of the operation.

Attributes

DefaultOverloadAttribute OverloadAttribute RemoteAsyncAttribute

See also

• CreateEndpointPairForPortsAsync(XboxLiveDeviceAddress, String, String)