Skip to content

Commit 246e236

Browse files
Merge pull request #3765 from MicrosoftDocs/main638301258817819682sync_temp
For protected CLA branch, push strategy should use PR and merge to target branch method to work around git push error
2 parents 8c9443f + 4fe60bb commit 246e236

File tree

1 file changed

+8
-5
lines changed

1 file changed

+8
-5
lines changed

uwp/launch-resume/launch-screen-snipping.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,24 +20,27 @@ The **ms-screenclip:** URI allows your app to automatically open up and start a
2020
| Parameter | Type | Required | Description |
2121
| --- | --- | --- | --- |
2222
| source | string | no | A freeform string to indicate the source that launched the URI. |
23+
| type | string | no | A string value to indicate which special type of capture is requested. This parameter can be omitted when starting a new snip. Values supported include: snapshot, recording\* |
2324
| clippingMode | string | no | A string value to indicate the clipping type for the snip. Values supported include: Rectangle, Freeform, Window |
2425
| delayInSeconds | int | no | An integer value, from 1 to 30. Specifies the delay, in full seconds, between the URI call and when snipping begins. |
2526
| callbackformat | string | no | This parameter is unavailable. |
2627

27-
## Launching the Snip & Sketch App
28+
\* `type=recording` is available only on Windows 11 PCs with Snipping Tool version 11.2307 or newer, and only when the default handler for ms-screenclip is set to "Snipping Tool" instead of "Screen Clipping".
2829

29-
The **ms-screensketch:** URI allows you to programatically launch the Snip & Sketch app, and open a specific image in that app for annotation.
30+
## Launching the Snipping Tool or Snip & Sketch App
31+
32+
The **ms-screensketch:** URI allows you to programatically launch the Snipping Tool app (on Windows 11) or Snip & Sketch app (on Windows 10), and open a specific image in that app for annotation.
3033

3134
**ms-screensketch:** takes the following parameters:
3235

3336
| Parameter | Type | Required | Description |
3437
| --- | --- | --- | --- |
35-
| sharedAccessToken | string | no | A token identifying the file to open in the Snip & Sketch app. Retrieved from [SharedStorageAccessManager.AddFile](/uwp/api/windows.applicationmodel.datatransfer.sharedstorageaccessmanager.addfile). If this parameter is omitted, the app will be launched without a file open. |
38+
| sharedAccessToken | string | no | A token identifying the file to open. Retrieved from [SharedStorageAccessManager.AddFile](/uwp/api/windows.applicationmodel.datatransfer.sharedstorageaccessmanager.addfile). If this parameter is omitted, the app will be launched without a file open. |
3639
| secondarySharedAccessToken | string | no | A string identifying a JSON file with metadata about the snip. The metadata may include a **clipPoints** field with an array of x,y coordinates, and/or a [userActivity](/uwp/api/windows.applicationmodel.useractivities.useractivity). |
3740
| source | string | no | A freeform string to indicate the source that launched the URI. |
38-
| isTemporary | bool | no | If set to True, Screen Sketch will try to delete the file after opening it. |
41+
| isTemporary | bool | no | If set to True, Snipping Tool will try to delete the file after opening it. |
3942

40-
The following example calls the [LaunchUriAsync](/uwp/api/Windows.System.Launcher#Windows_System_Launcher_LaunchUriAsync_Windows_Foundation_Uri_) method to send an image to Snip & Sketch from the user's app.
43+
The following example calls the [LaunchUriAsync](/uwp/api/Windows.System.Launcher#Windows_System_Launcher_LaunchUriAsync_Windows_Foundation_Uri_) method to send an image to Snipping Tool from the user's app.
4144

4245
```csharp
4346

0 commit comments

Comments
 (0)