XboxLiveEndpointPairTemplate.CreateEndpointPairAsync Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Overloads
| CreateEndpointPairAsync(XboxLiveDeviceAddress) |
Creates an XboxLiveEndpointPair between the local device and a specified remote device, based on the current template, 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. |
| CreateEndpointPairAsync(XboxLiveDeviceAddress, XboxLiveEndpointPairCreationBehaviors) |
Creates an XboxLiveEndpointPair between the local device and a specified remote device, while specifying how the system should behave if an XboxLiveEndpointPair already exists for this template and remote device. 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. |
CreateEndpointPairAsync(XboxLiveDeviceAddress)
Creates an XboxLiveEndpointPair between the local device and a specified remote device, based on the current template, 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 ^> ^ CreateEndpointPairAsync(XboxLiveDeviceAddress ^ deviceAddress) = CreateEndpointPairAsync;/// [Windows.Foundation.Metadata.DefaultOverload]
/// [Windows.Foundation.Metadata.Overload("CreateEndpointPairDefaultAsync")]
/// [Windows.Foundation.Metadata.RemoteAsync]
IAsyncOperation<XboxLiveEndpointPairCreationResult> CreateEndpointPairAsync(XboxLiveDeviceAddress const& deviceAddress);[Windows.Foundation.Metadata.DefaultOverload]
[Windows.Foundation.Metadata.Overload("CreateEndpointPairDefaultAsync")]
[Windows.Foundation.Metadata.RemoteAsync]
public IAsyncOperation<XboxLiveEndpointPairCreationResult> CreateEndpointPairAsync(XboxLiveDeviceAddress deviceAddress);function createEndpointPairAsync(deviceAddress)Public Function CreateEndpointPairAsync (deviceAddress As XboxLiveDeviceAddress) As IAsyncOperation(Of XboxLiveEndpointPairCreationResult)Parameters
- deviceAddress
- XboxLiveDeviceAddress
The XboxLiveDeviceAddress of the remote device to be connected to.
Returns
An asynchronous endpoint creation operation. When the operation completes, contains the results of the operation.
- Attributes
Remarks
The most common way to get an address for the deviceAddress parameter is to be sent one from the Xbox Live matchmaking service.
See also
Applies to
CreateEndpointPairAsync(XboxLiveDeviceAddress, XboxLiveEndpointPairCreationBehaviors)
Creates an XboxLiveEndpointPair between the local device and a specified remote device, while specifying how the system should behave if an XboxLiveEndpointPair already exists for this template and remote device.
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 ^> ^ CreateEndpointPairAsync(XboxLiveDeviceAddress ^ deviceAddress, XboxLiveEndpointPairCreationBehaviors behaviors) = CreateEndpointPairAsync;/// [Windows.Foundation.Metadata.DefaultOverload]
/// [Windows.Foundation.Metadata.Overload("CreateEndpointPairWithBehaviorsAsync")]
/// [Windows.Foundation.Metadata.RemoteAsync]
IAsyncOperation<XboxLiveEndpointPairCreationResult> CreateEndpointPairAsync(XboxLiveDeviceAddress const& deviceAddress, XboxLiveEndpointPairCreationBehaviors const& behaviors);[Windows.Foundation.Metadata.DefaultOverload]
[Windows.Foundation.Metadata.Overload("CreateEndpointPairWithBehaviorsAsync")]
[Windows.Foundation.Metadata.RemoteAsync]
public IAsyncOperation<XboxLiveEndpointPairCreationResult> CreateEndpointPairAsync(XboxLiveDeviceAddress deviceAddress, XboxLiveEndpointPairCreationBehaviors behaviors);function createEndpointPairAsync(deviceAddress, behaviors)Public Function CreateEndpointPairAsync (deviceAddress As XboxLiveDeviceAddress, behaviors As XboxLiveEndpointPairCreationBehaviors) As IAsyncOperation(Of XboxLiveEndpointPairCreationResult)Parameters
- deviceAddress
- XboxLiveDeviceAddress
The XboxLiveDeviceAddress of the remote device for the endpoint pair.
- behaviors
- XboxLiveEndpointPairCreationBehaviors
A value that specifies how the system should behave 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
An asynchronous endpoint creation operation. When the operation completes, contains the results of the operation.
- Attributes
Remarks
The most common way to get an address for the deviceAddress parameter is to be sent one from the Xbox Live matchmaking service.
See also
Applies to
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for