Skip to content

Commit 15d62bb

Browse files
BriPotMSFTSteven White
authored andcommitted
Merged PR 21055: Game Enumeration improvements.
Game Enumeration documentation improvements for DMA
1 parent 7e9645f commit 15d62bb

47 files changed

Lines changed: 98 additions & 51 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

windows.gaming.preview.gamesenumeration/gamelist.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,10 @@ public class GameList
1010
# Windows.Gaming.Preview.GamesEnumeration.GameList
1111

1212
## -description
13-
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.
13+
A list of games on the local system that provides properties for launching and managing how a game runs in Game Mode.
1414

1515
## -remarks
16+
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.
1617

1718
### Version history
1819

windows.gaming.preview.gamesenumeration/gamelist_findallasync_1257462890.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,14 +10,15 @@ public Windows.Foundation.IAsyncOperation<Windows.Foundation.Collections.IVector
1010
# Windows.Gaming.Preview.GamesEnumeration.GameList.FindAllAsync
1111

1212
## -description
13-
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.
13+
Returns all [GameListEntries](gamelistentry.md) that match the provided packageFamilyName for the String parameter.
1414

1515
## -parameters
1616
### -param packageFamilyName
1717

1818
## -returns
1919

2020
## -remarks
21+
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.
2122

2223
## -examples
2324

windows.gaming.preview.gamesenumeration/gamelist_findallasync_326280522.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,12 @@ public Windows.Foundation.IAsyncOperation<Windows.Foundation.Collections.IVector
1010
# Windows.Gaming.Preview.GamesEnumeration.GameList.FindAllAsync
1111

1212
## -description
13-
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.
13+
Returns all [GameListEntries](gamelistentry.md).
1414

1515
## -returns
1616

1717
## -remarks
18+
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.
1819

1920
## -examples
2021

windows.gaming.preview.gamesenumeration/gamelist_gameadded.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,10 @@ static public event Windows.Gaming.Preview.GamesEnumeration.GameListChangedEvent
1010
# Windows.Gaming.Preview.GamesEnumeration.GameList.GameAdded
1111

1212
## -description
13-
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.
13+
Indicates that a new [GameListEntry](gamelistentry.md) has been added to the [GameList](gamelist.md).
1414

1515
## -remarks
16+
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.
1617

1718
## -examples
1819

windows.gaming.preview.gamesenumeration/gamelist_gameremoved.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,10 @@ static public event Windows.Gaming.Preview.GamesEnumeration.GameListRemovedEvent
1010
# Windows.Gaming.Preview.GamesEnumeration.GameList.GameRemoved
1111

1212
## -description
13-
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.
13+
Indicates that a [GameListEntry](gamelistentry.md) has been removed from the [GameList](gamelist.md).
1414

1515
## -remarks
16+
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.
1617

1718
## -examples
1819

windows.gaming.preview.gamesenumeration/gamelist_gameupdated.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,10 @@ static public event Windows.Gaming.Preview.GamesEnumeration.GameListChangedEvent
1010
# Windows.Gaming.Preview.GamesEnumeration.GameList.GameUpdated
1111

1212
## -description
13-
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.
13+
Indicates that a [GameListEntry](gamelistentry.md) has been updated in the [GameList](gamelist.md)
1414

1515
## -remarks
16+
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.
1617

1718
## -examples
1819

windows.gaming.preview.gamesenumeration/gamelist_mergeentriesasync_1990000092.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ public IAsyncOperation<GameListEntry> GameList.MergeEntriesAsync(GameListEntry l
1010
# Windows.Gaming.Preview.GamesEnumeration.GameList.MergeEntriesAsync
1111

1212
## -description
13-
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.
13+
Explicity merge two [GameListEntries](gamelistentry.md) to remove duplicates from the GameList.
1414

1515
## -parameters
1616
### -param left
@@ -20,6 +20,7 @@ This API is not available to all apps. Unless your developer account is speciall
2020
## -returns
2121

2222
## -remarks
23+
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.
2324

2425
## -see-also
2526

windows.gaming.preview.gamesenumeration/gamelist_unmergeentryasync_1493694782.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,14 +10,15 @@ public IAsyncOperation<GameListEntry>> GameList.UnmergeEntryAsync(GameListEntry
1010
# Windows.Gaming.Preview.GamesEnumeration.GameList.UnmergeEntryAsync
1111

1212
## -description
13-
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.
13+
Unmerge a [GameListEntry](gamelistentry.md) if previously combined. The [GameListEntry’s](gamelistentry.md) may be remerged in the new enumeration call.
1414

1515
## -parameters
1616
### -param mergedEntry
1717

1818
## -returns
1919

2020
## -remarks
21+
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.
2122

2223
## -see-also
2324

windows.gaming.preview.gamesenumeration/gamelistcategory.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ public enum Windows.Gaming.Preview.GamesEnumeration.GameListCategory : int
1010
# GameListCategory
1111

1212
## -description
13+
Provides context on if a [GameListEntry](gamelistentry.md) has been confirmed to be a game by either the user or the system.
1314

14-
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.
1515

1616
## -enum-fields
1717

@@ -28,6 +28,7 @@ The ConfirmedBySystem constant.
2828
The ConfirmedByUser constant.
2929

3030
## -remarks
31+
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.
3132

3233
## -examples
3334

windows.gaming.preview.gamesenumeration/gamelistchangedeventhandler.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,14 @@ public delegate void GameListChangedEventHandler(Windows.Gaming.Preview.GamesEnu
88
# Windows.Gaming.Preview.GamesEnumeration.GameListChangedEventHandler
99

1010
## -description
11-
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.
11+
Returns the [GameListEntry](gamelistentry.md) that was added or updated to the [GameList](gamelist.md)
1212

1313
## -parameters
1414
### -param game
1515

1616

1717
## -remarks
18+
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.
1819

1920
## -examples
2021

0 commit comments

Comments
 (0)