Skip to content

Experimental Microsoft.Windows.Storage.Pickers.* API #5240

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 57 commits into from
Mar 26, 2025
Merged

Experimental Microsoft.Windows.Storage.Pickers.* API #5240

merged 57 commits into from
Mar 26, 2025

Conversation

Hong-Xiang
Copy link
Contributor

Draft implementation for Microsoft.Windows.Storage.Pickers.* APIs following spec #5155.

DinahK-2SO and others added 30 commits December 12, 2024 14:01
@DinahK-2SO
Microsoft.Windows.Storage.Pickers.FileOpenPicker.PickSingleFileAsync (#…
a243907 
…4945)

Creating new API Microsoft.Windows.Storage.Pickers.FileOpenPicker.PickSingleFileAsync
@DinahK-2SO
add one telemetry
7a282f2
@DinahK-2SO
Merge codes from branch 'user/xianghong/pickers-prototype' at \protot…
e6997b5 
…ype-workingdir\Microsoft.Storage.Pickers

Squashed commit of the following:

commit 4ce840f
Author: Dinah Gao <x.kic8462852@gmail.com>
Date:   Wed Dec 11 15:00:41 2024 +0800

    add one telemetry

commit bbf72f8
Author: Dinah Gao <116714259+DinahK-2SO@users.noreply.github.com>
Date:   Tue Dec 10 11:01:23 2024 +0800

    Microsoft.Windows.Storage.Pickers.FileOpenPicker.PickSingleFileAsync (#4945)

    Creating new API Microsoft.Windows.Storage.Pickers.FileOpenPicker.PickSingleFileAsync

commit ff3f2a8
Author: Xiang Hong <hx.hongxiang@gmail.com>
Date:   Mon Dec 9 18:14:16 2024 +0800

    fix: fix project configuration and add certificate notes to README.md

commit e11c8e6
Author: Xiang Hong (from Dev Box) <xianghong@microsoft.com>
Date:   Sun Dec 8 20:54:23 2024 +0800

    update readme for folder description

commit c6966f3
Author: Xiang Hong (from Dev Box) <xianghong@microsoft.com>
Date:   Sun Dec 8 20:08:46 2024 +0800

    add a simple READEME

commit c17750f
Author: Xiang Hong (from Dev Box) <xianghong@microsoft.com>
Date:   Sun Dec 8 11:27:04 2024 +0800

    feature: add basic implementations for SavePickers FileExtension/SuggestedSaveFile/Name functionalities

commit 3be9dc1
Author: Xiang Hong (from Dev Box) <xianghong@microsoft.com>
Date:   Sun Dec 8 10:35:59 2024 +0800

    clean: code clean on naming styles etc

commit 9fcc249
Author: Xiang Hong (from Dev Box) <xianghong@microsoft.com>
Date:   Sat Dec 7 22:22:21 2024 +0800

    refactor: use WinRT MD5 hash string to Guid

commit 756bafa
Author: Xiang Hong (from Dev Box) <xianghong@microsoft.com>
Date:   Sat Dec 7 22:02:55 2024 +0800

    fix: fix file type filter issues and refactor to use PickParameters

commit 8dea72a
Author: Xiang Hong (from Dev Box) <xianghong@microsoft.com>
Date:   Sat Dec 7 19:46:45 2024 +0800

    feature: add COM FileSavePicker basic implementation

commit 37a5a75
Author: Xiang Hong <hx.hongxiang@gmail.com>
Date:   Sat Dec 7 17:13:55 2024 +0800

    add save file dialog usage in demo app

commit fc9a03a
Author: Xiang Hong <hx.hongxiang@gmail.com>
Date:   Sat Dec 7 12:06:47 2024 +0800

    feature: add folder functionalities to demo test app

commit 34556bd
Author: Xiang Hong <hx.hongxiang@gmail.com>
Date:   Fri Dec 6 22:51:55 2024 +0800

    feature: add COM based picker prototype basic implementation
@DinahK-2SO
add the pickers
e34f272
@DinahK-2SO
Fix build errors
9356b17 
msbuild dev\WindowsAppRuntime_DLL\WindowsAppRuntime_DLL.vcxproj
@DinahK-2SO
Cleanup ; add into projections
3af3177
@DinahK-2SO
fix build errors; clean up
3ae4f6d 
msbuild dev\Projections\CS\Microsoft.Windows.Storage.Pickers.Projection\Microsoft.Windows.Storage.Pickers.Projection.csproj
Merge remote-tracking branch 'origin/main' into user/xianghong/mergin…
16581a0 
…g-updated-main-branch-for-test-errors
Merge remote-tracking branch 'origin/main' into user/xianghong/mergin…
b1253ca 
…g-updated-main-branch-for-test-errors
@DinahK-2SO
graceful solution
1b84f8c
@DinahK-2SO
Merge branch 'main' of github.com:microsoft/WindowsAppSDK into user/x…
fd22a12 
…iaomgao/storage-pickers_graceful_solution
@DinahK-2SO
Merge pull request #4978 from microsoft/user/xiaomgao/storage-pickers…
764103b 
…_graceful_solution

Add the storage prickers project to solution; Merge latest main to our dev branch.
add ad hoc working in progress fix
9ad9cc8
Merge branch 'user/xianghong/storage-pickers-develop' of https://gith…
7cb3d59 
…ub.com/microsoft/WindowsAppSDK into user/xianghong/storage-pickers-develop
adding basic tests
965abec
@DinahK-2SO
allow optional filters; add test configs
bc22a5c
@DinahK-2SO
use relative path for postbuild script
30bc81a
@DinahK-2SO
update script - add cleanup
963de7f
@Hong-Xiang
Merge branch 'user/xianghong/storage-pickers-develop' into user/xiang…
228d2a9 
…hong/adding-test-prototype
@Hong-Xiang
Merge remote-tracking branch 'origin/main' into user/xianghong/adding…
bce05bf 
…-test-prototype
@Hong-Xiang
work in progress
b42b781
@DinahK-2SO
Squashed commit of the following:
8680c9e 
commit 4a6b97a
Author: Dinah Gao <x.kic8462852@gmail.com>
Date:   Tue Jan 14 13:43:22 2025 +0800

    create file for fileSavePicker

commit 369651d
Author: Dinah Gao <x.kic8462852@gmail.com>
Date:   Mon Jan 13 18:13:47 2025 +0800

    save investigation progress

commit f025b64
Author: Dinah Gao <x.kic8462852@gmail.com>
Date:   Mon Jan 13 11:54:10 2025 +0800

    update doc

commit cc4b8cb
Author: Dinah Gao <x.kic8462852@gmail.com>
Date:   Mon Jan 13 11:47:36 2025 +0800

    atls.lib

commit dc26511
Author: Dinah Gao <x.kic8462852@gmail.com>
Date:   Fri Jan 10 17:56:21 2025 +0800

    COM APIs

commit d0f487c
Author: Dinah Gao <x.kic8462852@gmail.com>
Date:   Fri Jan 10 15:05:10 2025 +0800

    fix file save picker not creating new file
@Hong-Xiang
ad hoc working, examing in progress
77cc485
@DinahK-2SO
Merge branch 'user/xianghong/adding-test-prototype' of github.com:mic…
97e227c 
…rosoft/WindowsAppSDK into user/xianghong/storage-pickers-develop
@Hong-Xiang
add unit test project for storage pickers APIs
c4d2768
@Hong-Xiang
Merge branch 'user/xianghong/storage-pickers-develop' into user/xiang…
999b3b4 
…hong/adding-test-prototype
@Hong-Xiang
fix project name
a1e2c91
@Hong-Xiang
Merge pull request #5040 from microsoft/user/xianghong/adding-test-pr…
bed7090 
…ototype

Add unit test project for StoragePickers API
@DinahK-2SO
remove [default_interface] in idl files
f8e8e54
@DinahK-2SO
Merge branch 'user/xianghong/storage-pickers-develop' of github.com:m…
d10e7fb 
…icrosoft/WindowsAppSDK into user/xianghong/storage-pickers-develop
codendone
codendone reviewed Mar 24, 2025
View reviewed changes
codendone
codendone reviewed Mar 24, 2025
View reviewed changes
dev/Interop/StoragePickers/PickerCommon.cpp
return winrt::hstring{ filePath.get() };
}

std::vector<COMDLG_FILTERSPEC> CaptureFilterSpec(std::vector<winrt::hstring>& buffer, winrt::Windows::Foundation::Collections::IVectorView<winrt::hstring> filters)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

buffer

Why pass in this buffer? It looks like parameters.FileTypeFilterData is what gets passed in, which I don't see anything using. Why not have the buffer just be a local, or skip it entirely to directly build result in a single loop?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for your questions.
The buffer and return result are both "out" values. The problem here is the returned Win32 styles COMDLG_FILTERSPEC only contains raw pointers (get from c_str() method of hstrings), which does not automatically expand lifetime of strings dynamically constructed in this function. The buffer is used to carry those strings and is expected to expand lifetime of those string to the lifetime of setting Common Item Dialog options.
Comments has been updated to hopefully reduce confusion on this

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider changing the CaptureFilterSpec functions to instead be member functions on PickerParameters. Then it doesn't need to take the buffer or return the vector, since it would just use these both locally.

Feel free to consider this for follow-up in a later change.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @codendone , Now we're refactoring the CaptureFilterSpec methods here #5434

codendone
codendone reviewed Mar 24, 2025
View reviewed changes
codendone
codendone reviewed Mar 24, 2025
View reviewed changes
codendone
codendone reviewed Mar 24, 2025
View reviewed changes
codendone
codendone reviewed Mar 24, 2025
View reviewed changes
codendone
codendone reviewed Mar 24, 2025
View reviewed changes
codendone
codendone reviewed Mar 24, 2025
View reviewed changes
codendone
codendone reviewed Mar 24, 2025
View reviewed changes
codendone
codendone reviewed Mar 24, 2025
View reviewed changes
codendone
codendone reviewed Mar 24, 2025
View reviewed changes
codendone
codendone reviewed Mar 24, 2025
View reviewed changes
codendone
codendone reviewed Mar 24, 2025
View reviewed changes
codendone
codendone reviewed Mar 24, 2025
View reviewed changes
@Hong-Xiang
Copy link
Contributor Author

/azp run

@azure-pipelines Azure Pipelines
Copy link

Azure Pipelines successfully started running 1 pipeline(s).

@DinahK-2SO
Copy link
Contributor

/azp run

@azure-pipelines Azure Pipelines
Copy link

Azure Pipelines successfully started running 1 pipeline(s).

@Hong-Xiang
Copy link
Contributor Author

/azp run

@azure-pipelines Azure Pipelines
Copy link

Azure Pipelines successfully started running 1 pipeline(s).

@Hong-Xiang Hong-Xiang merged commit b75d74e into main Mar 26, 2025
27 checks passed
@Hong-Xiang Hong-Xiang deleted the user/xianghong/storage-pickers-develop branch March 26, 2025 04:40
@Hong-Xiang Hong-Xiang mentioned this pull request May 30, 2025
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@AgneLukoseviciute AgneLukoseviciute AgneLukoseviciute left review comments

@DinahK-2SO DinahK-2SO DinahK-2SO left review comments

Copilot code review Copilot Copilot left review comments

@codendone codendone codendone approved these changes

@yeelam-gordon yeelam-gordon yeelam-gordon approved these changes

Assignees

@codendone codendone

Labels
needs-triage
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@Hong-Xiang @codendone @DinahK-2SO @AgneLukoseviciute @yeelam-gordon