nerdbank-gitversioning 3.8.38-alpha → 3.8.118
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/nbgv.cli/tools/net8.0/any/LibGit2Sharp.dll +0 -0
- package/nbgv.cli/tools/net8.0/any/Microsoft.Build.Framework.dll +0 -0
- package/nbgv.cli/tools/net8.0/any/Microsoft.Build.dll +0 -0
- package/nbgv.cli/tools/net8.0/any/Microsoft.Win32.SystemEvents.dll +0 -0
- package/nbgv.cli/tools/net8.0/any/Nerdbank.GitVersioning.dll +0 -0
- package/nbgv.cli/tools/net8.0/any/Nerdbank.GitVersioning.pdb +0 -0
- package/nbgv.cli/tools/net8.0/any/Nerdbank.GitVersioning.xml +147 -49
- package/nbgv.cli/tools/net8.0/any/NuGet.Commands.dll +0 -0
- package/nbgv.cli/tools/net8.0/any/NuGet.Common.dll +0 -0
- package/nbgv.cli/tools/net8.0/any/NuGet.Configuration.dll +0 -0
- package/nbgv.cli/tools/net8.0/any/NuGet.Credentials.dll +0 -0
- package/nbgv.cli/tools/net8.0/any/NuGet.DependencyResolver.Core.dll +0 -0
- package/nbgv.cli/tools/net8.0/any/NuGet.Frameworks.dll +0 -0
- package/nbgv.cli/tools/net8.0/any/NuGet.LibraryModel.dll +0 -0
- package/nbgv.cli/tools/net8.0/any/NuGet.PackageManagement.dll +0 -0
- package/nbgv.cli/tools/net8.0/any/NuGet.Packaging.dll +0 -0
- package/nbgv.cli/tools/net8.0/any/NuGet.ProjectModel.dll +0 -0
- package/nbgv.cli/tools/net8.0/any/NuGet.Protocol.dll +0 -0
- package/nbgv.cli/tools/net8.0/any/NuGet.Resolver.dll +0 -0
- package/nbgv.cli/tools/net8.0/any/NuGet.Versioning.dll +0 -0
- package/nbgv.cli/tools/net8.0/any/System.CommandLine.dll +0 -0
- package/nbgv.cli/tools/net8.0/any/System.Drawing.Common.dll +0 -0
- package/nbgv.cli/tools/net8.0/any/System.IO.Pipelines.dll +0 -0
- package/nbgv.cli/tools/net8.0/any/System.Private.Windows.Core.dll +0 -0
- package/nbgv.cli/tools/net8.0/any/System.Text.Encodings.Web.dll +0 -0
- package/nbgv.cli/tools/net8.0/any/System.Text.Json.dll +0 -0
- package/nbgv.cli/tools/net8.0/any/System.Threading.Tasks.Dataflow.dll +0 -0
- package/nbgv.cli/tools/net8.0/any/cs/System.CommandLine.resources.dll +0 -0
- package/nbgv.cli/tools/net8.0/any/de/System.CommandLine.resources.dll +0 -0
- package/nbgv.cli/tools/net8.0/any/es/System.CommandLine.resources.dll +0 -0
- package/nbgv.cli/tools/net8.0/any/fr/System.CommandLine.resources.dll +0 -0
- package/nbgv.cli/tools/net8.0/any/it/System.CommandLine.resources.dll +0 -0
- package/nbgv.cli/tools/net8.0/any/ja/System.CommandLine.resources.dll +0 -0
- package/nbgv.cli/tools/net8.0/any/ko/System.CommandLine.resources.dll +0 -0
- package/nbgv.cli/tools/net8.0/any/nbgv.deps.json +336 -486
- package/nbgv.cli/tools/net8.0/any/nbgv.dll +0 -0
- package/nbgv.cli/tools/net8.0/any/nbgv.exe +0 -0
- package/nbgv.cli/tools/net8.0/any/pl/System.CommandLine.resources.dll +0 -0
- package/nbgv.cli/tools/net8.0/any/pt-BR/System.CommandLine.resources.dll +0 -0
- package/nbgv.cli/tools/net8.0/any/ru/System.CommandLine.resources.dll +0 -0
- package/nbgv.cli/tools/net8.0/any/runtimes/browser/lib/net8.0/System.Text.Encodings.Web.dll +0 -0
- package/nbgv.cli/tools/net8.0/any/runtimes/linux-arm/native/libgit2-3f4182d.so +0 -0
- package/nbgv.cli/tools/net8.0/any/runtimes/linux-arm64/native/libgit2-3f4182d.so +0 -0
- package/nbgv.cli/tools/net8.0/any/runtimes/linux-musl-arm/native/libgit2-3f4182d.so +0 -0
- package/nbgv.cli/tools/net8.0/any/runtimes/linux-musl-arm64/native/libgit2-3f4182d.so +0 -0
- package/nbgv.cli/tools/net8.0/any/runtimes/linux-musl-x64/native/libgit2-3f4182d.so +0 -0
- package/nbgv.cli/tools/net8.0/any/runtimes/linux-ppc64le/native/libgit2-3f4182d.so +0 -0
- package/nbgv.cli/tools/net8.0/any/runtimes/linux-x64/native/libgit2-3f4182d.so +0 -0
- package/nbgv.cli/tools/net8.0/any/runtimes/osx-arm64/native/libgit2-3f4182d.dylib +0 -0
- package/nbgv.cli/tools/net8.0/any/runtimes/osx-x64/native/libgit2-3f4182d.dylib +0 -0
- package/nbgv.cli/tools/net8.0/any/runtimes/win/lib/net8.0/Microsoft.Win32.SystemEvents.dll +0 -0
- package/nbgv.cli/tools/net8.0/any/runtimes/win-arm64/native/git2-3f4182d.dll +0 -0
- package/nbgv.cli/tools/net8.0/any/runtimes/win-x64/native/git2-3f4182d.dll +0 -0
- package/nbgv.cli/tools/net8.0/any/runtimes/win-x86/native/git2-3f4182d.dll +0 -0
- package/nbgv.cli/tools/net8.0/any/tr/System.CommandLine.resources.dll +0 -0
- package/nbgv.cli/tools/net8.0/any/zh-Hans/System.CommandLine.resources.dll +0 -0
- package/nbgv.cli/tools/net8.0/any/zh-Hant/System.CommandLine.resources.dll +0 -0
- package/package.json +12 -12
- package/nbgv.cli/tools/net8.0/any/runtimes/linux-arm/native/libgit2-e632535.so +0 -0
- package/nbgv.cli/tools/net8.0/any/runtimes/linux-arm64/native/libgit2-e632535.so +0 -0
- package/nbgv.cli/tools/net8.0/any/runtimes/linux-musl-arm/native/libgit2-e632535.so +0 -0
- package/nbgv.cli/tools/net8.0/any/runtimes/linux-musl-arm64/native/libgit2-e632535.so +0 -0
- package/nbgv.cli/tools/net8.0/any/runtimes/linux-musl-x64/native/libgit2-e632535.so +0 -0
- package/nbgv.cli/tools/net8.0/any/runtimes/linux-x64/native/libgit2-e632535.so +0 -0
- package/nbgv.cli/tools/net8.0/any/runtimes/osx-arm64/native/libgit2-e632535.dylib +0 -0
- package/nbgv.cli/tools/net8.0/any/runtimes/osx-x64/native/libgit2-e632535.dylib +0 -0
- package/nbgv.cli/tools/net8.0/any/runtimes/unix/lib/netcoreapp3.0/System.Drawing.Common.dll +0 -0
- package/nbgv.cli/tools/net8.0/any/runtimes/win/lib/netcoreapp3.0/Microsoft.Win32.SystemEvents.dll +0 -0
- package/nbgv.cli/tools/net8.0/any/runtimes/win/lib/netcoreapp3.0/System.Drawing.Common.dll +0 -0
- package/nbgv.cli/tools/net8.0/any/runtimes/win-arm64/native/git2-e632535.dll +0 -0
- package/nbgv.cli/tools/net8.0/any/runtimes/win-x64/native/git2-e632535.dll +0 -0
- package/nbgv.cli/tools/net8.0/any/runtimes/win-x86/native/git2-e632535.dll +0 -0
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
@@ -372,7 +372,7 @@
|
|
|
372
372
|
No supported cloud build environment could be detected.
|
|
373
373
|
</summary>
|
|
374
374
|
</member>
|
|
375
|
-
<member name="M:Nerdbank.GitVersioning.Commands.CloudCommand.SetBuildVariables(System.String,System.Collections.Generic.IEnumerable{System.String},System.String,System.String,System.Boolean,System.Boolean,System.Collections.Generic.IEnumerable{System.Collections.Generic.KeyValuePair{System.String,System.String}},System.Boolean)">
|
|
375
|
+
<member name="M:Nerdbank.GitVersioning.Commands.CloudCommand.SetBuildVariables(System.String,System.Collections.Generic.IEnumerable{System.String},System.String,System.String,System.Boolean,System.Boolean,System.Boolean,System.Collections.Generic.IEnumerable{System.Collections.Generic.KeyValuePair{System.String,System.String}},System.Boolean)">
|
|
376
376
|
<summary>
|
|
377
377
|
Adds version variables to the the current cloud build environment.
|
|
378
378
|
</summary>
|
|
@@ -395,6 +395,9 @@
|
|
|
395
395
|
<param name="commonVars">
|
|
396
396
|
Controls whether to define common version variables as cloud build variables.
|
|
397
397
|
</param>
|
|
398
|
+
<param name="cloudBuildNumber">
|
|
399
|
+
Controls whether to emit the cloud build variable to set the build number.
|
|
400
|
+
</param>
|
|
398
401
|
<param name="additionalVariables">
|
|
399
402
|
Additional cloud build variables to define.
|
|
400
403
|
</param>
|
|
@@ -1109,17 +1112,18 @@
|
|
|
1109
1112
|
A sequence of possible filenames for the version file in preferred order.
|
|
1110
1113
|
</summary>
|
|
1111
1114
|
</member>
|
|
1112
|
-
<member name="M:Nerdbank.GitVersioning.LibGit2.LibGit2VersionFile.GetVersion(LibGit2Sharp.Commit,System.String,System.Collections.Generic.Dictionary{LibGit2Sharp.ObjectId,Nerdbank.GitVersioning.VersionOptions},
|
|
1115
|
+
<member name="M:Nerdbank.GitVersioning.LibGit2.LibGit2VersionFile.GetVersion(LibGit2Sharp.Commit,System.String,System.Collections.Generic.Dictionary{LibGit2Sharp.ObjectId,Nerdbank.GitVersioning.VersionOptions},Nerdbank.GitVersioning.VersionFileRequirements,Nerdbank.GitVersioning.VersionFileLocations@)">
|
|
1113
1116
|
<summary>
|
|
1114
1117
|
Reads the version.json file and returns the <see cref="T:Nerdbank.GitVersioning.VersionOptions"/> deserialized from it.
|
|
1115
1118
|
</summary>
|
|
1116
1119
|
<param name="commit">The commit to read from.</param>
|
|
1117
1120
|
<param name="repoRelativeProjectDirectory">The directory to consider when searching for the version.txt file.</param>
|
|
1118
1121
|
<param name="blobVersionCache">An optional blob cache for storing the raw parse results of a version.txt or version.json file (before any inherit merge operations are applied).</param>
|
|
1119
|
-
<param name="
|
|
1122
|
+
<param name="requirements"><inheritdoc cref="M:Nerdbank.GitVersioning.LibGit2.LibGit2VersionFile.GetVersionCore(Nerdbank.GitVersioning.VersionFileRequirements,Nerdbank.GitVersioning.VersionFileLocations@)" path="/param[@name='requirements']" /></param>
|
|
1123
|
+
<param name="locations"><inheritdoc cref="M:Nerdbank.GitVersioning.LibGit2.LibGit2VersionFile.GetVersionCore(Nerdbank.GitVersioning.VersionFileRequirements,Nerdbank.GitVersioning.VersionFileLocations@)" path="/param[@name='locations']" /></param>
|
|
1120
1124
|
<returns>The version information read from the file.</returns>
|
|
1121
1125
|
</member>
|
|
1122
|
-
<member name="M:Nerdbank.GitVersioning.LibGit2.LibGit2VersionFile.GetVersionCore(
|
|
1126
|
+
<member name="M:Nerdbank.GitVersioning.LibGit2.LibGit2VersionFile.GetVersionCore(Nerdbank.GitVersioning.VersionFileRequirements,Nerdbank.GitVersioning.VersionFileLocations@)">
|
|
1123
1127
|
<inheritdoc/>
|
|
1124
1128
|
</member>
|
|
1125
1129
|
<member name="T:Nerdbank.GitVersioning.ManagedGit.DeltaInstruction">
|
|
@@ -2327,6 +2331,26 @@
|
|
|
2327
2331
|
<member name="M:Nerdbank.GitVersioning.ManagedGit.GitRepository.Dispose">
|
|
2328
2332
|
<inheritdoc/>
|
|
2329
2333
|
</member>
|
|
2334
|
+
<member name="M:Nerdbank.GitVersioning.ManagedGit.GitRepository.TryReadIgnoreCaseFromConfigFile(System.String,System.Boolean@)">
|
|
2335
|
+
<summary>
|
|
2336
|
+
Attempts to read the core.ignorecase setting from a git config file.
|
|
2337
|
+
</summary>
|
|
2338
|
+
<param name="configPath">Path to the git config file.</param>
|
|
2339
|
+
<param name="ignoreCase">The value of core.ignorecase if found.</param>
|
|
2340
|
+
<returns>True if the setting was found and parsed successfully.</returns>
|
|
2341
|
+
</member>
|
|
2342
|
+
<member name="M:Nerdbank.GitVersioning.ManagedGit.GitRepository.GetGlobalConfigPath">
|
|
2343
|
+
<summary>
|
|
2344
|
+
Gets the path to the global git config file.
|
|
2345
|
+
</summary>
|
|
2346
|
+
<returns>The path to the global config file, or null if not found.</returns>
|
|
2347
|
+
</member>
|
|
2348
|
+
<member name="M:Nerdbank.GitVersioning.ManagedGit.GitRepository.ReadIgnoreCaseFromConfig">
|
|
2349
|
+
<summary>
|
|
2350
|
+
Reads the core.ignorecase setting from git configuration.
|
|
2351
|
+
</summary>
|
|
2352
|
+
<returns>True if case should be ignored, false otherwise.</returns>
|
|
2353
|
+
</member>
|
|
2330
2354
|
<member name="M:Nerdbank.GitVersioning.ManagedGit.GitRepository.EnumeratePackedRefsRaw(System.Boolean@)">
|
|
2331
2355
|
<summary>
|
|
2332
2356
|
Enumerate the lines in the packed-refs file. Skips comment lines.
|
|
@@ -2437,6 +2461,31 @@
|
|
|
2437
2461
|
The <see cref="T:Nerdbank.GitVersioning.ManagedGit.GitObjectId"/> of the requested node.
|
|
2438
2462
|
</returns>
|
|
2439
2463
|
</member>
|
|
2464
|
+
<member name="M:Nerdbank.GitVersioning.ManagedGit.GitTreeStreamingReader.FindNode(System.IO.Stream,System.ReadOnlySpan{System.Byte},System.Boolean)">
|
|
2465
|
+
<summary>
|
|
2466
|
+
Finds a specific node in a git tree.
|
|
2467
|
+
</summary>
|
|
2468
|
+
<param name="stream">
|
|
2469
|
+
A <see cref="T:System.IO.Stream"/> which represents the git tree.
|
|
2470
|
+
</param>
|
|
2471
|
+
<param name="name">
|
|
2472
|
+
The name of the node to find, in it UTF-8 representation.
|
|
2473
|
+
</param>
|
|
2474
|
+
<param name="ignoreCase">
|
|
2475
|
+
Whether to ignore case when matching node names.
|
|
2476
|
+
</param>
|
|
2477
|
+
<returns>
|
|
2478
|
+
The <see cref="T:Nerdbank.GitVersioning.ManagedGit.GitObjectId"/> of the requested node.
|
|
2479
|
+
</returns>
|
|
2480
|
+
</member>
|
|
2481
|
+
<member name="M:Nerdbank.GitVersioning.ManagedGit.GitTreeStreamingReader.CompareIgnoreCase(System.ReadOnlySpan{System.Byte},System.ReadOnlySpan{System.Byte})">
|
|
2482
|
+
<summary>
|
|
2483
|
+
Compares two byte sequences case-insensitively (assuming UTF-8 encoding with ASCII characters).
|
|
2484
|
+
</summary>
|
|
2485
|
+
<param name="a">First byte sequence.</param>
|
|
2486
|
+
<param name="b">Second byte sequence.</param>
|
|
2487
|
+
<returns>True if the sequences are equal ignoring case.</returns>
|
|
2488
|
+
</member>
|
|
2440
2489
|
<member name="T:Nerdbank.GitVersioning.ManagedGit.MemoryMappedStream">
|
|
2441
2490
|
<summary>
|
|
2442
2491
|
Provides read-only, seekable access to a <see cref="T:System.IO.MemoryMappedFiles.MemoryMappedFile"/>.
|
|
@@ -2777,17 +2826,18 @@
|
|
|
2777
2826
|
</summary>
|
|
2778
2827
|
<param name="context"><inheritdoc /></param>
|
|
2779
2828
|
</member>
|
|
2780
|
-
<member name="M:Nerdbank.GitVersioning.Managed.ManagedVersionFile.GetVersion(Nerdbank.GitVersioning.ManagedGit.GitCommit,System.String,System.Collections.Generic.Dictionary{Nerdbank.GitVersioning.ManagedGit.GitObjectId,Nerdbank.GitVersioning.VersionOptions},
|
|
2829
|
+
<member name="M:Nerdbank.GitVersioning.Managed.ManagedVersionFile.GetVersion(Nerdbank.GitVersioning.ManagedGit.GitCommit,System.String,System.Collections.Generic.Dictionary{Nerdbank.GitVersioning.ManagedGit.GitObjectId,Nerdbank.GitVersioning.VersionOptions},Nerdbank.GitVersioning.VersionFileRequirements,Nerdbank.GitVersioning.VersionFileLocations@)">
|
|
2781
2830
|
<summary>
|
|
2782
2831
|
Reads the version.json file and returns the <see cref="T:Nerdbank.GitVersioning.VersionOptions"/> deserialized from it.
|
|
2783
2832
|
</summary>
|
|
2784
2833
|
<param name="commit">The commit to read from.</param>
|
|
2785
2834
|
<param name="repoRelativeProjectDirectory">The directory to consider when searching for the version.txt file.</param>
|
|
2786
2835
|
<param name="blobVersionCache">An optional blob cache for storing the raw parse results of a version.txt or version.json file (before any inherit merge operations are applied).</param>
|
|
2787
|
-
<param name="
|
|
2836
|
+
<param name="requirements"><inheritdoc cref="M:Nerdbank.GitVersioning.Managed.ManagedVersionFile.GetVersionCore(Nerdbank.GitVersioning.VersionFileRequirements,Nerdbank.GitVersioning.VersionFileLocations@)" path="/param[@name='requirements']" /></param>
|
|
2837
|
+
<param name="locations"><inheritdoc cref="M:Nerdbank.GitVersioning.Managed.ManagedVersionFile.GetVersionCore(Nerdbank.GitVersioning.VersionFileRequirements,Nerdbank.GitVersioning.VersionFileLocations@)" path="/param[@name='locations']" /></param>
|
|
2788
2838
|
<returns>The version information read from the file.</returns>
|
|
2789
2839
|
</member>
|
|
2790
|
-
<member name="M:Nerdbank.GitVersioning.Managed.ManagedVersionFile.GetVersionCore(
|
|
2840
|
+
<member name="M:Nerdbank.GitVersioning.Managed.ManagedVersionFile.GetVersionCore(Nerdbank.GitVersioning.VersionFileRequirements,Nerdbank.GitVersioning.VersionFileLocations@)">
|
|
2791
2841
|
<inheritdoc/>
|
|
2792
2842
|
</member>
|
|
2793
2843
|
<member name="P:Nerdbank.GitVersioning.NoGitContext.VersionFile">
|
|
@@ -2826,7 +2876,7 @@
|
|
|
2826
2876
|
<member name="M:Nerdbank.GitVersioning.NoGitContext.GetIdAsVersion(Nerdbank.GitVersioning.VersionOptions,Nerdbank.GitVersioning.VersionOptions,System.Int32)">
|
|
2827
2877
|
<inheritdoc/>
|
|
2828
2878
|
</member>
|
|
2829
|
-
<member name="M:Nerdbank.GitVersioning.NoGitVersionFile.GetVersionCore(
|
|
2879
|
+
<member name="M:Nerdbank.GitVersioning.NoGitVersionFile.GetVersionCore(Nerdbank.GitVersioning.VersionFileRequirements,Nerdbank.GitVersioning.VersionFileLocations@)">
|
|
2830
2880
|
<inheritdoc/>
|
|
2831
2881
|
</member>
|
|
2832
2882
|
<member name="T:Nerdbank.GitVersioning.ReleaseManager">
|
|
@@ -3309,20 +3359,27 @@
|
|
|
3309
3359
|
Gets the git context to use when reading version files.
|
|
3310
3360
|
</summary>
|
|
3311
3361
|
</member>
|
|
3362
|
+
<member name="P:Nerdbank.GitVersioning.VersionFile.VersionSearchRootToBranch">
|
|
3363
|
+
<summary>
|
|
3364
|
+
Gets a value indicating whether merging paths with <see cref="M:Nerdbank.GitVersioning.VersionFile.MergeLocations(Nerdbank.GitVersioning.VersionFileLocations@,Nerdbank.GitVersioning.VersionFileLocations)"/> and <see cref="M:Nerdbank.GitVersioning.VersionFile.ApplyLocations(Nerdbank.GitVersioning.VersionOptions,System.String,Nerdbank.GitVersioning.VersionFileLocations@)"/>
|
|
3365
|
+
prefer the new locations over the old ones.
|
|
3366
|
+
</summary>
|
|
3367
|
+
</member>
|
|
3312
3368
|
<member name="M:Nerdbank.GitVersioning.VersionFile.IsVersionDefined">
|
|
3313
3369
|
<summary>
|
|
3314
3370
|
Checks whether a version file is defined.
|
|
3315
3371
|
</summary>
|
|
3316
3372
|
<returns><see langword="true"/> if the version file is found; otherwise <see langword="false"/>.</returns>
|
|
3317
3373
|
</member>
|
|
3318
|
-
<member name="M:Nerdbank.GitVersioning.VersionFile.GetWorkingCopyVersion">
|
|
3319
|
-
<inheritdoc cref="M:Nerdbank.GitVersioning.VersionFile.GetWorkingCopyVersion(
|
|
3374
|
+
<member name="M:Nerdbank.GitVersioning.VersionFile.GetWorkingCopyVersion(Nerdbank.GitVersioning.VersionFileRequirements)">
|
|
3375
|
+
<inheritdoc cref="M:Nerdbank.GitVersioning.VersionFile.GetWorkingCopyVersion(Nerdbank.GitVersioning.VersionFileRequirements,Nerdbank.GitVersioning.VersionFileLocations@)"/>
|
|
3320
3376
|
</member>
|
|
3321
|
-
<member name="M:Nerdbank.GitVersioning.VersionFile.GetWorkingCopyVersion(
|
|
3377
|
+
<member name="M:Nerdbank.GitVersioning.VersionFile.GetWorkingCopyVersion(Nerdbank.GitVersioning.VersionFileRequirements,Nerdbank.GitVersioning.VersionFileLocations@)">
|
|
3322
3378
|
<summary>
|
|
3323
3379
|
Reads the version file from the working tree and returns the <see cref="T:Nerdbank.GitVersioning.VersionOptions"/> deserialized from it.
|
|
3324
3380
|
</summary>
|
|
3325
|
-
<param name="
|
|
3381
|
+
<param name="requirements"><inheritdoc cref="M:Nerdbank.GitVersioning.VersionFile.GetVersionCore(Nerdbank.GitVersioning.VersionFileRequirements,Nerdbank.GitVersioning.VersionFileLocations@)" path="/param[@name='requirements']" /></param>
|
|
3382
|
+
<param name="locations"><inheritdoc cref="M:Nerdbank.GitVersioning.VersionFile.GetVersionCore(Nerdbank.GitVersioning.VersionFileRequirements,Nerdbank.GitVersioning.VersionFileLocations@)" path="/param[@name='locations']" /></param>
|
|
3326
3383
|
<returns>The version information read from the file, or <see langword="null"/> if the file wasn't found.</returns>
|
|
3327
3384
|
</member>
|
|
3328
3385
|
<member name="M:Nerdbank.GitVersioning.VersionFile.SetVersion(System.String,System.Version,System.String,System.Boolean)">
|
|
@@ -3343,18 +3400,19 @@
|
|
|
3343
3400
|
<returns>The path to the file written.</returns>
|
|
3344
3401
|
</member>
|
|
3345
3402
|
<member name="M:Nerdbank.GitVersioning.VersionFile.GetVersion">
|
|
3346
|
-
<inheritdoc cref="M:Nerdbank.GitVersioning.VersionFile.GetVersion(
|
|
3403
|
+
<inheritdoc cref="M:Nerdbank.GitVersioning.VersionFile.GetVersion(Nerdbank.GitVersioning.VersionFileRequirements,Nerdbank.GitVersioning.VersionFileLocations@)"/>
|
|
3347
3404
|
</member>
|
|
3348
|
-
<member name="M:Nerdbank.GitVersioning.VersionFile.GetVersion(
|
|
3405
|
+
<member name="M:Nerdbank.GitVersioning.VersionFile.GetVersion(Nerdbank.GitVersioning.VersionFileRequirements,Nerdbank.GitVersioning.VersionFileLocations@)">
|
|
3349
3406
|
<summary>
|
|
3350
3407
|
Reads the version file from the selected git commit (or working copy if no commit is selected) and returns the <see cref="T:Nerdbank.GitVersioning.VersionOptions"/> deserialized from it.
|
|
3351
3408
|
</summary>
|
|
3352
|
-
<param name="
|
|
3409
|
+
<param name="requirements"><inheritdoc cref="M:Nerdbank.GitVersioning.VersionFile.GetVersionCore(Nerdbank.GitVersioning.VersionFileRequirements,Nerdbank.GitVersioning.VersionFileLocations@)" path="/param[@name='requirements']" /></param>
|
|
3410
|
+
<param name="locations"><inheritdoc cref="M:Nerdbank.GitVersioning.VersionFile.GetVersionCore(Nerdbank.GitVersioning.VersionFileRequirements,Nerdbank.GitVersioning.VersionFileLocations@)" path="/param[@name='locations']" /></param>
|
|
3353
3411
|
<returns>The version information read from the file, or <see langword="null"/> if the file wasn't found.</returns>
|
|
3354
3412
|
</member>
|
|
3355
3413
|
<member name="M:Nerdbank.GitVersioning.VersionFile.TryReadVersionJsonContent(System.String,System.String)">
|
|
3356
3414
|
<summary>
|
|
3357
|
-
Tries to read a version.json file from the specified string, but favors returning null instead of throwing a <see cref="T:Newtonsoft.Json.
|
|
3415
|
+
Tries to read a version.json file from the specified string, but favors returning null instead of throwing a <see cref="T:Newtonsoft.Json.JsonException"/>.
|
|
3358
3416
|
</summary>
|
|
3359
3417
|
<param name="jsonContent">The content of the version.json file.</param>
|
|
3360
3418
|
<param name="repoRelativeBaseDirectory">Directory that this version.json file is relative to the root of the repository.</param>
|
|
@@ -3367,22 +3425,56 @@
|
|
|
3367
3425
|
<param name="versionTextContent">The content of the version.txt file to read.</param>
|
|
3368
3426
|
<returns>The version information read from the file; or <see langword="null"/> if a deserialization error occurs.</returns>
|
|
3369
3427
|
</member>
|
|
3370
|
-
<member name="M:Nerdbank.GitVersioning.VersionFile.GetVersionCore(
|
|
3428
|
+
<member name="M:Nerdbank.GitVersioning.VersionFile.GetVersionCore(Nerdbank.GitVersioning.VersionFileRequirements,Nerdbank.GitVersioning.VersionFileLocations@)">
|
|
3371
3429
|
<summary>
|
|
3372
3430
|
Reads the version file from <see cref="P:Nerdbank.GitVersioning.GitContext.GitCommitId"/> in the <see cref="P:Nerdbank.GitVersioning.VersionFile.Context"/> and returns the <see cref="T:Nerdbank.GitVersioning.VersionOptions"/> deserialized from it.
|
|
3373
3431
|
</summary>
|
|
3374
|
-
<param name="
|
|
3432
|
+
<param name="requirements"><inheritdoc cref="M:Nerdbank.GitVersioning.VersionFile.GetVersionCore(Nerdbank.GitVersioning.VersionFileRequirements,Nerdbank.GitVersioning.VersionFileLocations@)" path="/param[@name='requirements']" /></param>
|
|
3433
|
+
<param name="locations"><inheritdoc cref="M:Nerdbank.GitVersioning.VersionFile.GetVersionCore(Nerdbank.GitVersioning.VersionFileRequirements,Nerdbank.GitVersioning.VersionFileLocations@)" path="/param[@name='locations']" /></param>
|
|
3375
3434
|
<returns>The version information read from the file, or <see langword="null"/> if the file wasn't found.</returns>
|
|
3376
3435
|
<remarks>This method is only called if <see cref="P:Nerdbank.GitVersioning.GitContext.GitCommitId"/> is not null.</remarks>
|
|
3377
3436
|
</member>
|
|
3378
|
-
<member name="M:Nerdbank.GitVersioning.VersionFile.GetWorkingCopyVersion(System.String,
|
|
3437
|
+
<member name="M:Nerdbank.GitVersioning.VersionFile.GetWorkingCopyVersion(System.String,Nerdbank.GitVersioning.VersionFileRequirements,Nerdbank.GitVersioning.VersionFileLocations@)">
|
|
3379
3438
|
<summary>
|
|
3380
3439
|
Reads a version file from the working tree, without any regard to a git repo.
|
|
3381
3440
|
</summary>
|
|
3382
3441
|
<param name="startingDirectory">The path to start the search from.</param>
|
|
3383
|
-
<param name="
|
|
3442
|
+
<param name="requirements"><inheritdoc cref="M:Nerdbank.GitVersioning.VersionFile.GetVersionCore(Nerdbank.GitVersioning.VersionFileRequirements,Nerdbank.GitVersioning.VersionFileLocations@)" path="/param[@name='requirements']" /></param>
|
|
3443
|
+
<param name="locations"><inheritdoc cref="M:Nerdbank.GitVersioning.VersionFile.GetVersionCore(Nerdbank.GitVersioning.VersionFileRequirements,Nerdbank.GitVersioning.VersionFileLocations@)" path="/param[@name='locations']" /></param>
|
|
3384
3444
|
<returns>The version options, if found.</returns>
|
|
3385
3445
|
</member>
|
|
3446
|
+
<member name="T:Nerdbank.GitVersioning.VersionFileLocations">
|
|
3447
|
+
<summary>
|
|
3448
|
+
Describes locations of version files found during a search.
|
|
3449
|
+
</summary>
|
|
3450
|
+
</member>
|
|
3451
|
+
<member name="P:Nerdbank.GitVersioning.VersionFileLocations.NonInheritingVersionDirectory">
|
|
3452
|
+
<summary>Gets or sets the absolute path to the directory where the first non-inheriting version file was found, if any.</summary>
|
|
3453
|
+
</member>
|
|
3454
|
+
<member name="P:Nerdbank.GitVersioning.VersionFileLocations.VersionSpecifyingVersionDirectory">
|
|
3455
|
+
<summary>Gets or sets the absolute path to the directory where the first version.json file with an actual version property set was found, if any.</summary>
|
|
3456
|
+
</member>
|
|
3457
|
+
<member name="F:Nerdbank.GitVersioning.VersionFileRequirements.Default">
|
|
3458
|
+
<summary>
|
|
3459
|
+
No flags. Default behavior.
|
|
3460
|
+
</summary>
|
|
3461
|
+
</member>
|
|
3462
|
+
<member name="F:Nerdbank.GitVersioning.VersionFileRequirements.NonMergedResult">
|
|
3463
|
+
<summary>
|
|
3464
|
+
We want a version options object initialized with <em>only</em> one version.json file (the one that matches other requirements),
|
|
3465
|
+
rather than the merge the result of all relevant version.json files.
|
|
3466
|
+
</summary>
|
|
3467
|
+
</member>
|
|
3468
|
+
<member name="F:Nerdbank.GitVersioning.VersionFileRequirements.VersionSpecified">
|
|
3469
|
+
<summary>
|
|
3470
|
+
We require a version.json file that specifies a version (i.e. has a "version" property).
|
|
3471
|
+
</summary>
|
|
3472
|
+
</member>
|
|
3473
|
+
<member name="F:Nerdbank.GitVersioning.VersionFileRequirements.AcceptInheritingFile">
|
|
3474
|
+
<summary>
|
|
3475
|
+
Stop search at the first version.json found, even if it inherits from another.
|
|
3476
|
+
</summary>
|
|
3477
|
+
</member>
|
|
3386
3478
|
<member name="T:Nerdbank.GitVersioning.VersionOptions">
|
|
3387
3479
|
<summary>
|
|
3388
3480
|
Describes the various versions and options required for the build.
|
|
@@ -3547,6 +3639,7 @@
|
|
|
3547
3639
|
<member name="F:Nerdbank.GitVersioning.VersionOptions.CloudBuildNumberCommitWhere.FourthVersionComponent">
|
|
3548
3640
|
<summary>
|
|
3549
3641
|
The commit ID appears as the 4th integer in the version (e.g. 1.2.3.23523).
|
|
3642
|
+
Specifically, the first 15 bits of the commit hash are used as the 4th integer.
|
|
3550
3643
|
</summary>
|
|
3551
3644
|
</member>
|
|
3552
3645
|
<member name="T:Nerdbank.GitVersioning.VersionOptions.ReleaseVersionIncrement">
|
|
@@ -4705,7 +4798,7 @@
|
|
|
4705
4798
|
<member name="F:Windows.Win32.Foundation.HANDLE.INVALID_HANDLE_VALUE">
|
|
4706
4799
|
<summary>There is no interactive user. The trust provider performs the verification action without the user's assistance.</summary>
|
|
4707
4800
|
<remarks>
|
|
4708
|
-
<para><see href="https://
|
|
4801
|
+
<para><see href="https://learn.microsoft.com/windows/win32/api/wintrust/nf-wintrust-winverifytrust">Learn more about this API from docs.microsoft.com</see>.</para>
|
|
4709
4802
|
</remarks>
|
|
4710
4803
|
</member>
|
|
4711
4804
|
<member name="T:Windows.Win32.Foundation.PCWSTR">
|
|
@@ -4736,7 +4829,7 @@
|
|
|
4736
4829
|
</member>
|
|
4737
4830
|
<member name="T:Windows.Win32.FreeLibrarySafeHandle">
|
|
4738
4831
|
<summary>
|
|
4739
|
-
Represents a Win32 handle that can be closed with <see cref="M:Windows.Win32.PInvoke.FreeLibrary(Windows.Win32.Foundation.
|
|
4832
|
+
Represents a Win32 handle that can be closed with <see cref="M:Windows.Win32.PInvoke.FreeLibrary(Windows.Win32.Foundation.HMODULE)"/>.
|
|
4740
4833
|
</summary>
|
|
4741
4834
|
</member>
|
|
4742
4835
|
<member name="T:Windows.Win32.PInvoke">
|
|
@@ -4748,87 +4841,91 @@
|
|
|
4748
4841
|
<summary>Closes an open object handle.</summary>
|
|
4749
4842
|
<param name="hObject">A valid handle to an open object.</param>
|
|
4750
4843
|
<returns>
|
|
4751
|
-
<para>If the function succeeds, the return value is nonzero. If the function fails, the return value is zero. To get extended error information, call <a href="/windows/desktop/api/errhandlingapi/nf-errhandlingapi-getlasterror">GetLastError</a>. If the application is running under a debugger, the function will throw an exception if it receives either a handle value that is not valid or a pseudo-handle value. This can happen if you close a handle twice, or if you call <b>CloseHandle</b> on a handle returned by the <a href="/windows/desktop/api/fileapi/nf-fileapi-findfirstfilea">FindFirstFile</a> function instead of calling the <a href="/windows/desktop/api/fileapi/nf-fileapi-findclose">FindClose</a> function.</para>
|
|
4844
|
+
<para>If the function succeeds, the return value is nonzero. If the function fails, the return value is zero. To get extended error information, call <a href="https://docs.microsoft.com/windows/desktop/api/errhandlingapi/nf-errhandlingapi-getlasterror">GetLastError</a>. If the application is running under a debugger, the function will throw an exception if it receives either a handle value that is not valid or a pseudo-handle value. This can happen if you close a handle twice, or if you call <b>CloseHandle</b> on a handle returned by the <a href="https://docs.microsoft.com/windows/desktop/api/fileapi/nf-fileapi-findfirstfilea">FindFirstFile</a> function instead of calling the <a href="https://docs.microsoft.com/windows/desktop/api/fileapi/nf-fileapi-findclose">FindClose</a> function.</para>
|
|
4752
4845
|
</returns>
|
|
4753
4846
|
<remarks>
|
|
4754
|
-
<para
|
|
4847
|
+
<para>The <b>CloseHandle</b> function closes handles to the following objects: </para>
|
|
4848
|
+
<para>This doc was truncated.</para>
|
|
4849
|
+
<para><see href="https://learn.microsoft.com/windows/win32/api/handleapi/nf-handleapi-closehandle#">Read more on docs.microsoft.com</see>.</para>
|
|
4755
4850
|
</remarks>
|
|
4756
4851
|
</member>
|
|
4757
4852
|
<member name="M:Windows.Win32.PInvoke.CreateFile(System.String,System.UInt32,Windows.Win32.Storage.FileSystem.FILE_SHARE_MODE,System.Nullable{Windows.Win32.Security.SECURITY_ATTRIBUTES},Windows.Win32.Storage.FileSystem.FILE_CREATION_DISPOSITION,Windows.Win32.Storage.FileSystem.FILE_FLAGS_AND_ATTRIBUTES,System.Runtime.InteropServices.SafeHandle)">
|
|
4758
4853
|
<inheritdoc cref="M:Windows.Win32.PInvoke.CreateFile(Windows.Win32.Foundation.PCWSTR,System.UInt32,Windows.Win32.Storage.FileSystem.FILE_SHARE_MODE,Windows.Win32.Security.SECURITY_ATTRIBUTES*,Windows.Win32.Storage.FileSystem.FILE_CREATION_DISPOSITION,Windows.Win32.Storage.FileSystem.FILE_FLAGS_AND_ATTRIBUTES,Windows.Win32.Foundation.HANDLE)"/>
|
|
4759
4854
|
</member>
|
|
4760
4855
|
<member name="M:Windows.Win32.PInvoke.CreateFile(Windows.Win32.Foundation.PCWSTR,System.UInt32,Windows.Win32.Storage.FileSystem.FILE_SHARE_MODE,Windows.Win32.Security.SECURITY_ATTRIBUTES*,Windows.Win32.Storage.FileSystem.FILE_CREATION_DISPOSITION,Windows.Win32.Storage.FileSystem.FILE_FLAGS_AND_ATTRIBUTES,Windows.Win32.Foundation.HANDLE)">
|
|
4761
|
-
<summary>Creates or opens a file or I/O device. The most commonly used I/O devices are as follows:\_file, file stream, directory, physical disk, volume, console buffer, tape drive, communications resource, mailslot, and pipe
|
|
4856
|
+
<summary>Creates or opens a file or I/O device. The most commonly used I/O devices are as follows:\_file, file stream, directory, physical disk, volume, console buffer, tape drive, communications resource, mailslot, and pipe. (Unicode)</summary>
|
|
4762
4857
|
<param name="lpFileName">
|
|
4763
4858
|
<para>The name of the file or device to be created or opened. You may use either forward slashes (/) or backslashes (\\) in this name. In the ANSI version of this function, the name is limited to <b>MAX_PATH</b> characters. To extend this limit to 32,767 wide characters, use this Unicode version of the function and prepend "\\\\?\\" to the path. For more information, see <a href="https://docs.microsoft.com/windows/desktop/FileIO/naming-a-file">Naming Files, Paths, and Namespaces</a>. For information on special device names, see <a href="https://docs.microsoft.com/windows/desktop/FileIO/defining-an-ms-dos-device-name">Defining an MS-DOS Device Name</a>. To create a file stream, specify the name of the file, a colon, and then the name of the stream. For more information, see <a href="https://docs.microsoft.com/windows/desktop/FileIO/file-streams">File Streams</a>. <div class="alert"><b>Tip</b> Starting with Windows 10, version 1607, for the unicode version of this function (<b>CreateFileW</b>), you can opt-in to remove the <b>MAX_PATH</b> limitation without prepending "\\?\". See the "Maximum Path Length Limitation" section of <a href="https://docs.microsoft.com/windows/desktop/FileIO/naming-a-file">Naming Files, Paths, and Namespaces</a> for details.</div> <div> </div></para>
|
|
4764
|
-
<para><see href="https://
|
|
4859
|
+
<para><see href="https://learn.microsoft.com/windows/win32/api/fileapi/nf-fileapi-createfilew#parameters">Read more on docs.microsoft.com</see>.</para>
|
|
4765
4860
|
</param>
|
|
4766
4861
|
<param name="dwDesiredAccess">
|
|
4767
4862
|
<para>The requested access to the file or device, which can be summarized as read, write, both or neither zero). The most commonly used values are <b>GENERIC_READ</b>, <b>GENERIC_WRITE</b>, or both (<c>GENERIC_READ | GENERIC_WRITE</c>). For more information, see <a href="https://docs.microsoft.com/windows/desktop/SecAuthZ/generic-access-rights">Generic Access Rights</a>, <a href="https://docs.microsoft.com/windows/desktop/FileIO/file-security-and-access-rights">File Security and Access Rights</a>, <a href="https://docs.microsoft.com/windows/desktop/FileIO/file-access-rights-constants">File Access Rights Constants</a>, and <a href="https://docs.microsoft.com/windows/desktop/SecAuthZ/access-mask">ACCESS_MASK</a>. If this parameter is zero, the application can query certain metadata such as file, directory, or device attributes without accessing that file or device, even if <b>GENERIC_READ</b> access would have been denied. You cannot request an access mode that conflicts with the sharing mode that is specified by the <i>dwShareMode</i> parameter in an open request that already has an open handle. For more information, see the Remarks section of this topic and <a href="https://docs.microsoft.com/windows/desktop/FileIO/creating-and-opening-files">Creating and Opening Files</a>.</para>
|
|
4768
|
-
<para><see href="https://
|
|
4863
|
+
<para><see href="https://learn.microsoft.com/windows/win32/api/fileapi/nf-fileapi-createfilew#parameters">Read more on docs.microsoft.com</see>.</para>
|
|
4769
4864
|
</param>
|
|
4770
4865
|
<param name="dwShareMode">
|
|
4771
4866
|
<para>The requested sharing mode of the file or device, which can be read, write, both, delete, all of these, or none (refer to the following table). Access requests to attributes or extended attributes are not affected by this flag. If this parameter is zero and <b>CreateFile</b> succeeds, the file or device cannot be shared and cannot be opened again until the handle to the file or device is closed. For more information, see the Remarks section. You cannot request a sharing mode that conflicts with the access mode that is specified in an existing request that has an open handle. <b>CreateFile</b> would fail and the <a href="https://docs.microsoft.com/windows/desktop/api/errhandlingapi/nf-errhandlingapi-getlasterror">GetLastError</a> function would return <b>ERROR_SHARING_VIOLATION</b>. To enable a process to share a file or device while another process has the file or device open, use a</para>
|
|
4772
|
-
<para><see href="https://
|
|
4867
|
+
<para><see href="https://learn.microsoft.com/windows/win32/api/fileapi/nf-fileapi-createfilew#parameters">Read more on docs.microsoft.com</see>.</para>
|
|
4773
4868
|
</param>
|
|
4774
4869
|
<param name="lpSecurityAttributes">
|
|
4775
|
-
<para>A pointer to a <a href="https://docs.microsoft.com/previous-versions/windows/desktop/legacy/aa379560(v=vs.85)">SECURITY_ATTRIBUTES</a> structure that contains two separate but related data members: an optional security descriptor, and a Boolean value that determines whether the returned handle can be inherited by child processes. This parameter can be <b>NULL</b>. If this parameter is <b>NULL</b>, the handle returned by <b>CreateFile</b> cannot be inherited by any child processes the application may create and the file or device associated with the returned handle gets a default security descriptor. The <b>lpSecurityDescriptor</b> member of the structure specifies a <a href="https://docs.microsoft.com/windows/desktop/api/winnt/ns-winnt-security_descriptor">SECURITY_DESCRIPTOR</a> for a file or device. If this member is <b>NULL</b>, the file or device associated with the returned handle is assigned a default security descriptor. <b>CreateFile</b> ignores the <b>lpSecurityDescriptor</b> member when opening an existing file or device, but continues to use the <b>bInheritHandle</b> member. The <b>bInheritHandle</b>member of the structure specifies whether the returned handle can be inherited. For more information, see the Remarks section.</para>
|
|
4776
|
-
<para><see href="https://
|
|
4870
|
+
<para>A pointer to a <a href="https://docs.microsoft.com/previous-versions/windows/desktop/legacy/aa379560(v=vs.85)">SECURITY_ATTRIBUTES</a> structure that contains two separate but related data members: an optional security descriptor, and a Boolean value that determines whether the returned handle can be inherited by child processes. This parameter can be <b>NULL</b>. If this parameter is <b>NULL</b>, the handle returned by <b>CreateFile</b> cannot be inherited by any child processes the application may create and the file or device associated with the returned handle gets a default security descriptor. The <b>lpSecurityDescriptor</b> member of the structure specifies a <a href="https://docs.microsoft.com/windows/desktop/api/winnt/ns-winnt-security_descriptor">SECURITY_DESCRIPTOR</a> for a file or device. If this member is <b>NULL</b>, the file or device associated with the returned handle is assigned a default security descriptor. <b>CreateFile</b> ignores the <b>lpSecurityDescriptor</b> member when opening an existing file or device, but continues to use the <b>bInheritHandle</b> member. The <b>bInheritHandle</b> member of the structure specifies whether the returned handle can be inherited. For more information, see the Remarks section.</para>
|
|
4871
|
+
<para><see href="https://learn.microsoft.com/windows/win32/api/fileapi/nf-fileapi-createfilew#parameters">Read more on docs.microsoft.com</see>.</para>
|
|
4777
4872
|
</param>
|
|
4778
4873
|
<param name="dwCreationDisposition">
|
|
4779
4874
|
<para>An action to take on a file or device that exists or does not exist. For devices other than files, this parameter is usually set to <b>OPEN_EXISTING</b>. For more information, see the Remarks section.</para>
|
|
4780
|
-
<para><see href="https://
|
|
4875
|
+
<para><see href="https://learn.microsoft.com/windows/win32/api/fileapi/nf-fileapi-createfilew#parameters">Read more on docs.microsoft.com</see>.</para>
|
|
4781
4876
|
</param>
|
|
4782
4877
|
<param name="dwFlagsAndAttributes">
|
|
4783
4878
|
<para>The file or device attributes and flags, <b>FILE_ATTRIBUTE_NORMAL</b> being the most common default value for files. This parameter can include any combination of the available file attributes (<b>FILE_ATTRIBUTE_*</b>). All other file attributes override <b>FILE_ATTRIBUTE_NORMAL</b>. This parameter can also contain combinations of flags (<b>FILE_FLAG_*</b>) for control of file or device caching behavior, access modes, and other special-purpose flags. These combine with any <b>FILE_ATTRIBUTE_*</b> values. This parameter can also contain Security Quality of Service (SQOS) information by specifying the <b>SECURITY_SQOS_PRESENT</b> flag. Additional SQOS-related flags information is presented in the table following the attributes and flags tables. <div class="alert"><b>Note</b> When <b>CreateFile</b> opens an existing file, it generally combines the file flags with the file attributes of the existing file, and ignores any file attributes supplied as part of <i>dwFlagsAndAttributes</i>. Special cases are detailed in <a href="https://docs.microsoft.com/windows/desktop/FileIO/creating-and-opening-files">Creating and Opening Files</a>.</div> <div> </div> Some of the following file attributes and flags may only apply to files and not necessarily all other types of devices that <b>CreateFile</b> can open. For additional information, see the Remarks section of this topic and <a href="https://docs.microsoft.com/windows/desktop/FileIO/creating-and-opening-files">Creating and Opening Files</a>. For more advanced access to file attributes, see <a href="https://docs.microsoft.com/windows/desktop/api/fileapi/nf-fileapi-setfileattributesa">SetFileAttributes</a>. For a complete list of all file attributes with their values and descriptions, see <a href="https://docs.microsoft.com/windows/desktop/FileIO/file-attribute-constants">File Attribute Constants</a>. </para>
|
|
4784
4879
|
<para>This doc was truncated.</para>
|
|
4785
|
-
<para><see href="https://
|
|
4880
|
+
<para><see href="https://learn.microsoft.com/windows/win32/api/fileapi/nf-fileapi-createfilew#parameters">Read more on docs.microsoft.com</see>.</para>
|
|
4786
4881
|
</param>
|
|
4787
4882
|
<param name="hTemplateFile">
|
|
4788
4883
|
<para>A valid handle to a template file with the <b>GENERIC_READ</b> access right. The template file supplies file attributes and extended attributes for the file that is being created. This parameter can be <b>NULL</b>. When opening an existing file, <b>CreateFile</b> ignores this parameter. When opening a new encrypted file, the file inherits the discretionary access control list from its parent directory. For additional information, see <a href="https://docs.microsoft.com/windows/desktop/FileIO/file-encryption">File Encryption</a>.</para>
|
|
4789
|
-
<para><see href="https://
|
|
4884
|
+
<para><see href="https://learn.microsoft.com/windows/win32/api/fileapi/nf-fileapi-createfilew#parameters">Read more on docs.microsoft.com</see>.</para>
|
|
4790
4885
|
</param>
|
|
4791
4886
|
<returns>
|
|
4792
|
-
<para>If the function succeeds, the return value is an open handle to the specified file, device, named pipe, or mail slot. If the function fails, the return value is <b>INVALID_HANDLE_VALUE</b>. To get extended error information, call <a href="/windows/desktop/api/errhandlingapi/nf-errhandlingapi-getlasterror">GetLastError</a>.</para>
|
|
4887
|
+
<para>If the function succeeds, the return value is an open handle to the specified file, device, named pipe, or mail slot. If the function fails, the return value is <b>INVALID_HANDLE_VALUE</b>. To get extended error information, call <a href="https://docs.microsoft.com/windows/desktop/api/errhandlingapi/nf-errhandlingapi-getlasterror">GetLastError</a>.</para>
|
|
4793
4888
|
</returns>
|
|
4794
4889
|
<remarks>
|
|
4795
|
-
<para><
|
|
4890
|
+
<para><b>CreateFile</b> was originally developed specifically for file interaction but has since been expanded and enhanced to include most other types of I/O devices and mechanisms available to Windows developers. This section attempts to cover the varied issues developers may experience when using <b>CreateFile</b> in different contexts and with different I/O types. The text attempts to use the word <i>file</i> only when referring specifically to data stored in an actual file on a file system. However, some uses of <i>file</i> may be referring more generally to an I/O object that supports file-like mechanisms. This liberal use of the term <i>file</i> is particularly prevalent in constant names and parameter names because of the previously mentioned historical reasons. When an application is finished using the object handle returned by <b>CreateFile</b>, use the <a href="https://docs.microsoft.com/windows/desktop/api/handleapi/nf-handleapi-closehandle">CloseHandle</a> function to close the handle. This not only frees up system resources, but can have wider influence on things like sharing the file or device and committing data to disk. Specifics are noted within this topic as appropriate. <b>Windows Server 2003 and Windows XP: </b>A sharing violation occurs if an attempt is made to open a file or directory for deletion on a remote computer when the value of the <i>dwDesiredAccess</i> parameter is the <b>DELETE</b> access flag (0x00010000) <b>OR</b>'ed with any other access flag, and the remote file or directory has not been opened with <b>FILE_SHARE_DELETE</b>. To avoid the sharing violation in this scenario, open the remote file or directory with the <b>DELETE</b> access right only, or call <a href="https://docs.microsoft.com/windows/desktop/api/fileapi/nf-fileapi-deletefilea">DeleteFile</a> without first opening the file or directory for deletion. Some file systems, such as the NTFS file system, support compression or encryption for individual files and directories. On volumes that have a mounted file system with this support, a new file inherits the compression and encryption attributes of its directory. You cannot use <b>CreateFile</b> to control compression, decompression, or decryption on a file or directory. For more information, see <a href="https://docs.microsoft.com/windows/desktop/FileIO/creating-and-opening-files">Creating and Opening Files</a>, <a href="https://docs.microsoft.com/windows/desktop/FileIO/file-compression-and-decompression">File Compression and Decompression</a>, and <a href="https://docs.microsoft.com/windows/desktop/FileIO/file-encryption">File Encryption</a>. <b>Windows Server 2003 and Windows XP: </b>For backward compatibility purposes, <b>CreateFile</b> does not apply inheritance rules when you specify a security descriptor in <i>lpSecurityAttributes</i>. To support inheritance, functions that later query the security descriptor of this file may heuristically determine and report that inheritance is in effect. For more information, see <a href="https://docs.microsoft.com/windows/desktop/SecAuthZ/automatic-propagation-of-inheritable-aces">Automatic Propagation of Inheritable ACEs</a>. As stated previously, if the <i>lpSecurityAttributes</i> parameter is <b>NULL</b>, the handle returned by <b>CreateFile</b> cannot be inherited by any child processes your application may create. The following information regarding this parameter also applies: </para>
|
|
4891
|
+
<para>This doc was truncated.</para>
|
|
4892
|
+
<para><see href="https://learn.microsoft.com/windows/win32/api/fileapi/nf-fileapi-createfilew#">Read more on docs.microsoft.com</see>.</para>
|
|
4796
4893
|
</remarks>
|
|
4797
4894
|
</member>
|
|
4798
|
-
<member name="M:Windows.Win32.PInvoke.FreeLibrary(Windows.Win32.Foundation.
|
|
4895
|
+
<member name="M:Windows.Win32.PInvoke.FreeLibrary(Windows.Win32.Foundation.HMODULE)">
|
|
4799
4896
|
<summary>Frees the loaded dynamic-link library (DLL) module and, if necessary, decrements its reference count.</summary>
|
|
4800
4897
|
<param name="hLibModule">
|
|
4801
4898
|
<para>A handle to the loaded library module. The <a href="https://docs.microsoft.com/windows/desktop/api/libloaderapi/nf-libloaderapi-loadlibrarya">LoadLibrary</a>, <a href="https://docs.microsoft.com/windows/desktop/api/libloaderapi/nf-libloaderapi-loadlibraryexa">LoadLibraryEx</a>, <a href="https://docs.microsoft.com/windows/desktop/api/libloaderapi/nf-libloaderapi-getmodulehandlea">GetModuleHandle</a>, or <a href="https://docs.microsoft.com/windows/desktop/api/libloaderapi/nf-libloaderapi-getmodulehandleexa">GetModuleHandleEx</a> function returns this handle.</para>
|
|
4802
|
-
<para><see href="https://
|
|
4899
|
+
<para><see href="https://learn.microsoft.com/windows/win32/api/libloaderapi/nf-libloaderapi-freelibrary#parameters">Read more on docs.microsoft.com</see>.</para>
|
|
4803
4900
|
</param>
|
|
4804
4901
|
<returns>
|
|
4805
|
-
<para>If the function succeeds, the return value is nonzero. If the function fails, the return value is zero. To get extended error information, call the <a href="/windows/desktop/api/errhandlingapi/nf-errhandlingapi-getlasterror">GetLastError</a> function.</para>
|
|
4902
|
+
<para>If the function succeeds, the return value is nonzero. If the function fails, the return value is zero. To get extended error information, call the <a href="https://docs.microsoft.com/windows/desktop/api/errhandlingapi/nf-errhandlingapi-getlasterror">GetLastError</a> function.</para>
|
|
4806
4903
|
</returns>
|
|
4807
4904
|
<remarks>
|
|
4808
|
-
<para
|
|
4905
|
+
<para>The system maintains a per-process reference count for each loaded module. A module that was loaded at process initialization due to load-time dynamic linking has a reference count of one. The reference count for a module is incremented each time the module is loaded by a call to <a href="https://docs.microsoft.com/windows/desktop/api/libloaderapi/nf-libloaderapi-loadlibrarya">LoadLibrary</a>. The reference count is also incremented by a call to <a href="https://docs.microsoft.com/windows/desktop/api/libloaderapi/nf-libloaderapi-loadlibraryexa">LoadLibraryEx</a> unless the module is being loaded for the first time and is being loaded as a data or image file. The reference count is decremented each time the <b>FreeLibrary</b> or <a href="https://docs.microsoft.com/windows/desktop/api/libloaderapi/nf-libloaderapi-freelibraryandexitthread">FreeLibraryAndExitThread</a> function is called for the module. When a module's reference count reaches zero or the process terminates, the system unloads the module from the address space of the process. Before unloading a library module, the system enables the module to detach from the process by calling the module's <a href="https://docs.microsoft.com/windows/desktop/Dlls/dllmain">DllMain</a> function, if it has one, with the DLL_PROCESS_DETACH value. Doing so gives the library module an opportunity to clean up resources allocated on behalf of the current process. After the entry-point function returns, the library module is removed from the address space of the current process. It is not safe to call <b>FreeLibrary</b> from <a href="https://docs.microsoft.com/windows/desktop/Dlls/dllmain">DllMain</a>. For more information, see the Remarks section in <a href="https://docs.microsoft.com/windows/desktop/Dlls/dllmain">DllMain</a>. Calling <b>FreeLibrary</b> does not affect other processes that are using the same module. Use caution when calling <b>FreeLibrary</b> with a handle returned by <a href="https://docs.microsoft.com/windows/desktop/api/libloaderapi/nf-libloaderapi-getmodulehandlea">GetModuleHandle</a>. The <b>GetModuleHandle</b> function does not increment a module's reference count, so passing this handle to <b>FreeLibrary</b> can cause a module to be unloaded prematurely. A thread that must unload the DLL in which it is executing and then terminate itself should call <a href="https://docs.microsoft.com/windows/desktop/api/libloaderapi/nf-libloaderapi-freelibraryandexitthread">FreeLibraryAndExitThread</a> instead of calling <b>FreeLibrary</b> and <b>ExitThread</b> separately. Otherwise, a race condition can occur. For details, see the Remarks section of <a href="https://docs.microsoft.com/windows/desktop/api/libloaderapi/nf-libloaderapi-freelibraryandexitthread">FreeLibraryAndExitThread</a>.</para>
|
|
4906
|
+
<para><see href="https://learn.microsoft.com/windows/win32/api/libloaderapi/nf-libloaderapi-freelibrary#">Read more on docs.microsoft.com</see>.</para>
|
|
4809
4907
|
</remarks>
|
|
4810
4908
|
</member>
|
|
4811
4909
|
<member name="M:Windows.Win32.PInvoke.LoadLibrary(System.String)">
|
|
4812
4910
|
<inheritdoc cref="M:Windows.Win32.PInvoke.LoadLibrary(Windows.Win32.Foundation.PCWSTR)"/>
|
|
4813
4911
|
</member>
|
|
4814
4912
|
<member name="M:Windows.Win32.PInvoke.LoadLibrary(Windows.Win32.Foundation.PCWSTR)">
|
|
4815
|
-
<summary>Loads the specified module into the address space of the calling process
|
|
4913
|
+
<summary>Loads the specified module into the address space of the calling process. (LoadLibraryW)</summary>
|
|
4816
4914
|
<param name="lpLibFileName">
|
|
4817
|
-
<para>The name of the module. This can be either a library module (a .dll file) or an executable module (an .exe file). The name specified is the file name of the module and is not related to the name stored in the library module itself, as specified by the <b>LIBRARY</b> keyword in the module-definition (.def) file. If the string specifies a full path, the function searches only that path for the module. If the string specifies a relative path or a module name without a path, the function uses a standard search strategy to find the module; for more information, see the Remarks. If the function cannot find the module, the function fails. When specifying a path, be sure to use backslashes (\\), not forward slashes (/). For more information about paths, see <a href="https://docs.microsoft.com/windows/desktop/FileIO/naming-a-file">Naming a File or Directory</a>. If the string specifies a module name without a path and the file name extension is omitted, the function appends the default library extension .
|
|
4818
|
-
<para><see href="https://
|
|
4915
|
+
<para>The name of the module. This can be either a library module (a .dll file) or an executable module (an .exe file). If the specified module is an executable module, static imports are not loaded; instead, the module is loaded as if by <a href="https://docs.microsoft.com/windows/desktop/api/libloaderapi/nf-libloaderapi-loadlibraryexw">LoadLibraryEx</a> with the `DONT_RESOLVE_DLL_REFERENCES` flag. The name specified is the file name of the module and is not related to the name stored in the library module itself, as specified by the <b>LIBRARY</b> keyword in the module-definition (.def) file. If the string specifies a full path, the function searches only that path for the module. If the string specifies a relative path or a module name without a path, the function uses a standard search strategy to find the module; for more information, see the Remarks. If the function cannot find the module, the function fails. When specifying a path, be sure to use backslashes (\\), not forward slashes (/). For more information about paths, see <a href="https://docs.microsoft.com/windows/desktop/FileIO/naming-a-file">Naming a File or Directory</a>. If the string specifies a module name without a path and the file name extension is omitted, the function appends the default library extension ".DLL" to the module name. To prevent the function from appending ".DLL" to the module name, include a trailing point character (.) in the module name string.</para>
|
|
4916
|
+
<para><see href="https://learn.microsoft.com/windows/win32/api/libloaderapi/nf-libloaderapi-loadlibraryw#parameters">Read more on docs.microsoft.com</see>.</para>
|
|
4819
4917
|
</param>
|
|
4820
4918
|
<returns>
|
|
4821
|
-
<para>If the function succeeds, the return value is a handle to the module. If the function fails, the return value is NULL. To get extended error information, call <a href="/windows/desktop/api/errhandlingapi/nf-errhandlingapi-getlasterror">GetLastError</a>.</para>
|
|
4919
|
+
<para>If the function succeeds, the return value is a handle to the module. If the function fails, the return value is NULL. To get extended error information, call <a href="https://docs.microsoft.com/windows/desktop/api/errhandlingapi/nf-errhandlingapi-getlasterror">GetLastError</a>.</para>
|
|
4822
4920
|
</returns>
|
|
4823
4921
|
<remarks>
|
|
4824
|
-
<para
|
|
4922
|
+
<para>To enable or disable error messages displayed by the loader during DLL loads, use the <a href="https://docs.microsoft.com/windows/desktop/api/errhandlingapi/nf-errhandlingapi-seterrormode">SetErrorMode</a> function. <b>LoadLibrary</b> can be used to load a library module into the address space of the process and return a handle that can be used in <a href="https://docs.microsoft.com/windows/desktop/api/libloaderapi/nf-libloaderapi-getprocaddress">GetProcAddress</a> to get the address of a DLL function. <b>LoadLibrary</b> can also be used to load other executable modules. For example, the function can specify an .exe file to get a handle that can be used in <a href="https://docs.microsoft.com/windows/desktop/api/winbase/nf-winbase-findresourcea">FindResource</a> or <a href="https://docs.microsoft.com/windows/desktop/api/libloaderapi/nf-libloaderapi-loadresource">LoadResource</a>. However, do not use <b>LoadLibrary</b> to run an .exe file. Instead, use the <a href="https://docs.microsoft.com/windows/desktop/api/processthreadsapi/nf-processthreadsapi-createprocessa">CreateProcess</a> function. If the specified module is a DLL that is not already loaded for the calling process, the system calls the DLL's <a href="https://docs.microsoft.com/windows/desktop/Dlls/dllmain">DllMain</a> function with the <b>DLL_PROCESS_ATTACH</b> value. If <b>DllMain</b> returns <b>TRUE</b>, <b>LoadLibrary</b> returns a handle to the module. If <b>DllMain</b> returns <b>FALSE</b>, the system unloads the DLL from the process address space and <b>LoadLibrary</b> returns <b>NULL</b>. It is not safe to call <b>LoadLibrary</b> from <b>DllMain</b>. For more information, see the Remarks section in <b>DllMain</b>. Module handles are not global or inheritable. A call to <b>LoadLibrary</b> by one process does not produce a handle that another process can use — for example, in calling <a href="https://docs.microsoft.com/windows/desktop/api/libloaderapi/nf-libloaderapi-getprocaddress">GetProcAddress</a>. The other process must make its own call to <b>LoadLibrary</b> for the module before calling <b>GetProcAddress</b>. If <i>lpFileName</i> does not include a path and there is more than one loaded module with the same base name and extension, the function returns a handle to the module that was loaded first. If no file name extension is specified in the <i>lpFileName</i> parameter, the default library extension .dll is appended. However, the file name string can include a trailing point character (.) to indicate that the module name has no extension. When no path is specified, the function searches for loaded modules whose base name matches the base name of the module to be loaded. If the name matches, the load succeeds. Otherwise, the function searches for the file. The first directory searched is the directory containing the image file used to create the calling process (for more information, see the <a href="https://docs.microsoft.com/windows/desktop/api/processthreadsapi/nf-processthreadsapi-createprocessa">CreateProcess</a> function). Doing this allows private dynamic-link library (DLL) files associated with a process to be found without adding the process's installed directory to the PATH environment variable. If a relative path is specified, the entire relative path is appended to every token in the DLL search path list. To load a module from a relative path without searching any other path, use <a href="https://docs.microsoft.com/windows/desktop/api/fileapi/nf-fileapi-getfullpathnamea">GetFullPathName</a> to get a nonrelative path and call <b>LoadLibrary</b> with the nonrelative path. For more information on the DLL search order, see <a href="https://docs.microsoft.com/windows/desktop/Dlls/dynamic-link-library-search-order">Dynamic-Link Library Search Order</a>. The search path can be altered using the <a href="https://docs.microsoft.com/windows/desktop/api/winbase/nf-winbase-setdlldirectorya">SetDllDirectory</a> function. This solution is recommended instead of using <a href="https://docs.microsoft.com/windows/desktop/api/winbase/nf-winbase-setcurrentdirectory">SetCurrentDirectory</a> or hard-coding the full path to the DLL. If a path is specified and there is a redirection file for the application, the function searches for the module in the application's directory. If the module exists in the application's directory, <b>LoadLibrary</b> ignores the specified path and loads the module from the application's directory. If the module does not exist in the application's directory, <b>LoadLibrary</b> loads the module from the specified directory. For more information, see <a href="https://docs.microsoft.com/windows/desktop/Dlls/dynamic-link-library-redirection">Dynamic Link Library Redirection</a>. If you call <b>LoadLibrary</b> with the name of an assembly without a path specification and the assembly is listed in the system compatible manifest, the call is automatically redirected to the side-by-side assembly. The system maintains a per-process reference count on all loaded modules. Calling <b>LoadLibrary</b> increments the reference count. Calling the <a href="https://docs.microsoft.com/windows/desktop/api/libloaderapi/nf-libloaderapi-freelibrary">FreeLibrary</a> or <a href="https://docs.microsoft.com/windows/desktop/api/libloaderapi/nf-libloaderapi-freelibraryandexitthread">FreeLibraryAndExitThread</a> function decrements the reference count. The system unloads a module when its reference count reaches zero or when the process terminates (regardless of the reference count). <b>Windows Server 2003 and Windows XP: </b>The Visual C++ compiler supports a syntax that enables you to declare thread-local variables: <b>_declspec(thread)</b>. If you use this syntax in a DLL, you will not be able to load the DLL explicitly using <b>LoadLibrary</b> on versions of Windows prior to Windows Vista. If your DLL will be loaded explicitly, you must use the thread local storage functions instead of <b>_declspec(thread)</b>. For an example, see <a href="https://docs.microsoft.com/windows/desktop/Dlls/using-thread-local-storage-in-a-dynamic-link-library">Using Thread Local Storage in a Dynamic Link Library</a>. <h3><a id="Security_Remarks"></a><a id="security_remarks"></a><a id="SECURITY_REMARKS"></a>Security Remarks</h3> Do not use the <a href="https://docs.microsoft.com/windows/desktop/api/processenv/nf-processenv-searchpathw">SearchPath</a> function to retrieve a path to a DLL for a subsequent <b>LoadLibrary</b> call. The <b>SearchPath</b> function uses a different search order than <b>LoadLibrary</b> and it does not use safe process search mode unless this is explicitly enabled by calling <a href="https://docs.microsoft.com/windows/desktop/api/winbase/nf-winbase-setsearchpathmode">SetSearchPathMode</a> with <b>BASE_SEARCH_PATH_ENABLE_SAFE_SEARCHMODE</b>. Therefore, <b>SearchPath</b> is likely to first search the user’s current working directory for the specified DLL. If an attacker has copied a malicious version of a DLL into the current working directory, the path retrieved by <b>SearchPath</b> will point to the malicious DLL, which <b>LoadLibrary</b> will then load. Do not make assumptions about the operating system version based on a <b>LoadLibrary</b> call that searches for a DLL. If the application is running in an environment where the DLL is legitimately not present but a malicious version of the DLL is in the search path, the malicious version of the DLL may be loaded. Instead, use the recommended techniques described in <a href="https://docs.microsoft.com/windows/desktop/SysInfo/getting-the-system-version">Getting the System Version</a>.</para>
|
|
4923
|
+
<para><see href="https://learn.microsoft.com/windows/win32/api/libloaderapi/nf-libloaderapi-loadlibraryw#">Read more on docs.microsoft.com</see>.</para>
|
|
4825
4924
|
</remarks>
|
|
4826
4925
|
</member>
|
|
4827
4926
|
<member name="T:Windows.Win32.Security.SECURITY_ATTRIBUTES">
|
|
4828
4927
|
<summary>The SECURITY_ATTRIBUTES structure contains the security descriptor for an object and specifies whether the handle retrieved by specifying this structure is inheritable.</summary>
|
|
4829
|
-
<remarks>
|
|
4830
|
-
<para><see href="https://docs.microsoft.com/windows/win32/api//wtypesbase/ns-wtypesbase-security_attributes#">Read more on docs.microsoft.com</see>.</para>
|
|
4831
|
-
</remarks>
|
|
4928
|
+
<remarks></remarks>
|
|
4832
4929
|
</member>
|
|
4833
4930
|
<member name="F:Windows.Win32.Security.SECURITY_ATTRIBUTES.nLength">
|
|
4834
4931
|
<summary>The size, in bytes, of this structure. Set this value to the size of the **SECURITY\_ATTRIBUTES** structure.</summary>
|
|
@@ -4836,7 +4933,7 @@
|
|
|
4836
4933
|
<member name="F:Windows.Win32.Security.SECURITY_ATTRIBUTES.lpSecurityDescriptor">
|
|
4837
4934
|
<summary>
|
|
4838
4935
|
<para>A pointer to a [**SECURITY\_DESCRIPTOR**](../winnt/ns-winnt-security_descriptor.md) structure that controls access to the object. If the value of this member is **NULL**, the object is assigned the default security descriptor associated with the [*access token*](/windows/win32/secauthz/access-tokens) of the calling process. This is not the same as granting access to everyone by assigning a **NULL** [*discretionary access control list*](/windows/win32/secauthz/dacls-and-aces) (DACL). By default, the default DACL in the access token of a process allows access only to the user represented by the access token. For information about creating a security descriptor, see [Creating a Security Descriptor](/windows/win32/secauthz/creating-a-security-descriptor-for-a-new-object-in-c--).</para>
|
|
4839
|
-
<para><see href="https://
|
|
4936
|
+
<para><see href="https://learn.microsoft.com/windows/win32/api/wtypesbase/ns-wtypesbase-security_attributes#members">Read more on docs.microsoft.com</see>.</para>
|
|
4840
4937
|
</summary>
|
|
4841
4938
|
</member>
|
|
4842
4939
|
<member name="F:Windows.Win32.Security.SECURITY_ATTRIBUTES.bInheritHandle">
|
|
@@ -4844,7 +4941,8 @@
|
|
|
4844
4941
|
</member>
|
|
4845
4942
|
<member name="T:System.Runtime.CompilerServices.OverloadResolutionPriorityAttribute">
|
|
4846
4943
|
<summary>
|
|
4847
|
-
Specifies the priority of a member in overload resolution.
|
|
4944
|
+
Specifies the priority of a member in overload resolution.
|
|
4945
|
+
When unspecified, the default priority is 0.
|
|
4848
4946
|
</summary>
|
|
4849
4947
|
</member>
|
|
4850
4948
|
<member name="M:System.Runtime.CompilerServices.OverloadResolutionPriorityAttribute.#ctor(System.Int32)">
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|