XboxLiveDeviceAddress.GetSnapshotAsBase64 Method

Definition

Namespace:

Windows.Networking.XboxLive

Gets a snapshot of the current XboxLiveDeviceAddress as a Base64-encoded string.

You can save this snapshot to use later as the base64 parameter in a call to XboxLiveDeviceAddress.CreateFromSnapshotBase64.

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 Platform::String ^ GetSnapshotAsBase64() = GetSnapshotAsBase64;

winrt::hstring GetSnapshotAsBase64();

public string GetSnapshotAsBase64();

function getSnapshotAsBase64()

Public Function GetSnapshotAsBase64 () As String

Returns

String

Platform::String

winrt::hstring

The snapshot, as a Base64-encoded string.

Remarks

Snapshots are serialized forms of XboxLiveDeviceAddress objects that can be transmitted to remote devices through out-of-band channels such as Xbox Live matchmaking. However, they represent a device's network address information at a particular time, and they can change over time. To avoid unnecessary connectivity problems, you should listen for XboxLiveDeviceAddress.SnapshotChanged events on the local device address to know when its snapshot contents have been updated, and refresh the serialized snapshot anywhere you've transmitted or cached it, so that remote devices always have the latest information.