Skip to content

Commit 34cbb69

Browse files
Add note to CredentialPicker API about non-UWP app restriction (#2472)
* Update CredentialPicker::PickAsync(options) for Caption requirement * Update more members * Update credentialpicker_pickasync_1330776073.md * Update credentialpicker_pickasync_1621420115.md * Update credentialpicker_pickasync_693496969.md --------- Co-authored-by: Steven White <31261191+stevewhims@users.noreply.github.com>
1 parent 7229d25 commit 34cbb69

3 files changed

Lines changed: 12 additions & 3 deletions

File tree

windows.security.credentials.ui/credentialpicker_pickasync_1330776073.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ public Windows.Foundation.IAsyncOperation<Windows.Security.Credentials.UI.Creden
1313
Constructor used to initiate asynchronous prompting operations using three inputs.
1414

1515
## -parameters
16+
1617
### -param targetName
1718
The target name to display.
1819

@@ -22,6 +23,9 @@ The message to display in the dialog box.
2223
### -param caption
2324
The caption to display in the dialog box.
2425

26+
> [!NOTE]
27+
> This value must be set for a non-UWP (that is, desktop) app.
28+
2529
## -returns
2630
The credential and options from the user.
2731

@@ -30,4 +34,4 @@ The credential and options from the user.
3034
## -examples
3135

3236
## -see-also
33-
[PickAsync(CredentialPickerOptions)](credentialpicker_pickasync_1621420115.md), [PickAsync(String, String)](credentialpicker_pickasync_693496969.md)
37+
[PickAsync(CredentialPickerOptions)](credentialpicker_pickasync_1621420115.md), [PickAsync(String, String)](credentialpicker_pickasync_693496969.md)

windows.security.credentials.ui/credentialpicker_pickasync_1621420115.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,9 @@ Displays a dialog box to the user and collects credentials from the user.
1616
### -param options
1717
The options on displaying and collecting the credential box.
1818

19+
> [!NOTE]
20+
> In a non-UWP (that is, desktop) app, the [CredentialPickerOptions.Caption](/uwp/api/Windows.Security.Credentials.UI.CredentialPickerOptions.Caption) must be set.
21+
1922
## -returns
2023
The credential and options from the user.
2124

@@ -24,4 +27,4 @@ The credential and options from the user.
2427
## -examples
2528

2629
## -see-also
27-
[PickAsync(String, String)](credentialpicker_pickasync_693496969.md), [PickAsync(String, String, String)](credentialpicker_pickasync_1330776073.md)
30+
[PickAsync(String, String)](credentialpicker_pickasync_693496969.md), [PickAsync(String, String, String)](credentialpicker_pickasync_1330776073.md)

windows.security.credentials.ui/credentialpicker_pickasync_693496969.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,9 @@ The credential and options from the user.
2424

2525
## -remarks
2626

27+
This method is supported only in UWP apps. In a non-UWP (that is, desktop) app, use the three-parameter overload, and set the *caption* parameter.
28+
2729
## -examples
2830

2931
## -see-also
30-
[PickAsync(CredentialPickerOptions)](credentialpicker_pickasync_1621420115.md), [PickAsync(String, String, String)](credentialpicker_pickasync_1330776073.md)
32+
[PickAsync(CredentialPickerOptions)](credentialpicker_pickasync_1621420115.md), [PickAsync(String, String, String)](credentialpicker_pickasync_1330776073.md)

0 commit comments

Comments
 (0)