Share via


XboxLiveDeviceAddress.CreateFromSnapshotBase64(String) Method

Definition

Creates an XboxLiveDeviceAddress object from a snapshot stored in Base64 encoding.

Use this method to create an XboxLiveDeviceAddress from the Base64-encoded snapshot returned from an earlier call to XboxLiveDeviceAddress.GetSnapshotAsBase64.

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:
 static XboxLiveDeviceAddress ^ CreateFromSnapshotBase64(Platform::String ^ base64);
 static XboxLiveDeviceAddress CreateFromSnapshotBase64(winrt::hstring const& base64);
public static XboxLiveDeviceAddress CreateFromSnapshotBase64(string base64);
function createFromSnapshotBase64(base64)
Public Shared Function CreateFromSnapshotBase64 (base64 As String) As XboxLiveDeviceAddress

Parameters

base64
String

Platform::String

winrt::hstring

A Base64-encoded snapshot representing an XboxLiveDeviceAddress.

Returns

The XboxLiveDeviceAddress represented by the snapshot.

Remarks

The Base64-encoded snapshot is expected to originate from a previous call to GetSnapshotAsBase64 on the local or remote device, without modification. If the contents of the snapshot have been altered or corrupted, then an XboxLiveDeviceAddress object is returned, but the IsValid property is false; and attempts to use the XboxLiveDeviceAddress to create an endpoint pair will fail.

Applies to