Skip to content

Clarify doc/XML comments with information about enumeration sort order #51

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

Merged
cgallred merged 1 commit into from
Dec 9, 2020
Merged

Clarify doc/XML comments with information about enumeration sort order #51

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions ProjectedFSLib.Managed.API/IDirectoryEnumerationResults.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,13 @@ public interface class IDirectoryEnumerationResults
/// provider returns <c>HResult.InsufficientBuffer</c> from the <c>GetDirectoryEnumerationCallback</c>
/// method.
/// </para>
/// <para>
/// IMPORTANT: File and directory names passed to this method must be in the sort
/// specified by <c>PrjFileNameCompare</c>
Copy link
Contributor

@cgallred cgallred Aug 26, 2020

Choose a reason for hiding this comment

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

This (and the others) should refer to Utils.FileNameCompare for clarity.

/// (see https://docs.microsoft.com/en-us/windows/win32/api/projectedfslib/nf-projectedfslib-prjfilenamecompare ),
/// or else names can be duplicated or missing from the enumeration results presented to the
/// process enumerating the filesystem.
/// </para>
/// </remarks>
/// <param name="fileName">The name of the file or directory.</param>
/// <param name="fileSize">The size of the file.</param>
Expand Down Expand Up @@ -69,6 +76,13 @@ public interface class IDirectoryEnumerationResults
/// provider returns <c>HResult.InsufficientBuffer</c> from the <c>GetDirectoryEnumerationCallback</c>
/// method.
/// </para>
/// <para>
/// IMPORTANT: File and directory names passed to this method must be in the sort
/// specified by <c>PrjFileNameCompare</c>
/// (see https://docs.microsoft.com/en-us/windows/win32/api/projectedfslib/nf-projectedfslib-prjfilenamecompare ),
/// or else names can be duplicated or missing from the enumeration results presented to the
/// process enumerating the filesystem.
/// </para>
/// </remarks>
/// <param name="fileName">The name of the file or directory.</param>
/// <param name="fileSize">The size of the file.</param>
Expand Down
10 changes: 10 additions & 0 deletions ProjectedFSLib.Managed.API/IRequiredCallbacks.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,11 @@ public interface class IRequiredCallbacks {
/// <para>If no entries match the search expression specified in <paramref name="filterFileName"/>,
/// or if all the entries in the directory were added in a previous invocation of this callback,
/// the provider must return <see cref="HResult::Ok"/>.</para>
/// <para>IMPORTANT: The provider must ensure file and directory names returned from this
/// callback are in the sort order specified by <c>PrjFileNameCompare</c>
/// (see https://docs.microsoft.com/en-us/windows/win32/api/projectedfslib/nf-projectedfslib-prjfilenamecompare ),
/// or else names can be duplicated or missing from the enumeration results presented to the
/// process enumerating the filesystem.</para>
/// </remarks>
/// <param name="commandId">
/// <para>A value that uniquely identifies an invocation of the callback.</para>
Expand Down Expand Up @@ -119,6 +124,11 @@ public interface class IRequiredCallbacks {
/// <para>If the provider returns <see cref="HResult::Pending"/> from this method, then it must pass
/// this value to <c>ProjFS.VirtualizationInstance.CompleteCommand</c> to provide the
/// enumeration results.</para>
/// <para>IMPORTANT: File and directory names passed to this parameter must be in the sort
/// order specified by <c>PrjFileNameCompare</c>
/// (see https://docs.microsoft.com/en-us/windows/win32/api/projectedfslib/nf-projectedfslib-prjfilenamecompare ),
/// or else names can be duplicated or missing from the enumeration results presented to the
/// process enumerating the filesystem.</para>
/// </param>
/// <returns>
/// <para><see cref="HResult::Ok"/> if the provider successfully completes the operation.</para>
Expand Down