PackageManager.FindPackages: clarify user scope and parameter formats#2531
Open
GrantMeStrength wants to merge 1 commit intodocsfrom
Open
PackageManager.FindPackages: clarify user scope and parameter formats#2531GrantMeStrength wants to merge 1 commit intodocsfrom
GrantMeStrength wants to merge 1 commit intodocsfrom
Conversation
Addresses community feedback (MicrosoftDocs/windows-dev-docs#5503): 1. FindPackages() — fix incorrect description ('specified family' copied from sibling overload); add note that results span all users. 2. FindPackages(String familyName) — add NOTE callout clarifying that packageFamilyName = Package.Id.FamilyName (not Name or FullName); wrong format silently returns empty collection. 3. FindPackages(String name, String publisher) — empty Remarks filled in: - All-users scope (not current user) now stated explicitly - packageName = Package.Id.Name (not FullName) - packagePublisher = Package.Id.Publisher (full X.500 DN, not PublisherId) - Recommend FindPackages(FamilyName) as simpler alternative Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
prmerger-automator
bot
added
do-not-merge
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes MicrosoftDocs/windows-dev-docs#5503
Community feedback: the
FindPackagesoverloads don't explain whether they return packages for all users or just the current user, and thepackageName/packageFamilyNameparameter formats are ambiguous — passing the wrong format silently returns an empty collection.Changes
FindPackages()FindPackagesForUserfor per-user queriesFindPackages(String familyName)[!NOTE]clarifyingpackageFamilyName=Package.Id.FamilyName(e.g.Microsoft.WindowsCalculator_8wekyb3d8bbwe), notId.NameorId.FullNameFindPackages(String name, String publisher)FindPackagesForUserfor per-user queriespackageName=Package.Id.Name(notFullName)packagePublisher=Package.Id.Publisher(full X.500 DN, notPublisherId)FindPackages(FamilyName)as a simpler, less error-prone alternative