Share via


GameListEntry Class

Definition

Provides a game's display info such as its display info, launch parameters, and game mode configuration, category and a method to launch the game.

public ref class GameListEntry sealed : IGameListEntry
public ref class GameListEntry sealed
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Gaming.Preview.GamesEnumerationContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
class GameListEntry final : IGameListEntry
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Gaming.Preview.GamesEnumerationContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
class GameListEntry final
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Gaming.Preview.GamesEnumerationContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
public sealed class GameListEntry : IGameListEntry
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Gaming.Preview.GamesEnumerationContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
public sealed class GameListEntry
Public NotInheritable Class GameListEntry
Implements IGameListEntry
Public NotInheritable Class GameListEntry
Inheritance
Object Platform::Object IInspectable GameListEntry
Attributes
Implements

Windows requirements

Device family
Windows Desktop Extension SDK (introduced in 10.0.10240.0)
Windows Mobile Extension SDK (introduced in 10.0.10240.0)
API contract
Windows.Gaming.Preview.GamesEnumerationContract (introduced in v1.0)
App capabilities
gameList

Remarks

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.

Version history

Windows version SDK version Value added
1709 16299 GameModeConfiguration
1709 16299 LaunchableState
1709 16299 LauncherExecutable
1709 16299 LaunchParameters
1709 16299 SetLauncherExecutableFileAsync(IStorageFile)
1709 16299 SetLauncherExecutableFileAsync(IStorageFile,String)
1709 16299 SetTitleIdAsync
1709 16299 TitleId

Properties

Category

The current GameListCategory value for the associated IGameListEntry.

DisplayInfo

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.

GameModeConfiguration

The game’s current GameModeConfiguration settings

LaunchableState

The game’s current GameListEntryLaunchableState

LauncherExecutable

The path to the game’s executable.

LaunchParameters

The game’s current launch parameters.

Properties

Gets a collection of all properties that pertain to the IGameListEntry object.

TitleId

The game’s TitleId this could come back with an empty string

Methods

LaunchAsync()

Launch the associated game.

SetCategoryAsync(GameListCategory)

Sets the GameListCategory.

SetLauncherExecutableFileAsync(IStorageFile, String)

Sets the launch path for the game’s executable. This can fail if the LaunchableState is set to ByTitle.

SetLauncherExecutableFileAsync(IStorageFile)

Sets the launch path for the game’s executable and launch parameters. This can fail if the LaunchableState is set to ByTitle.

SetTitleIdAsync(String)

Updates the TitleID.

Applies to

See also