Skip to content

Commit deb9f63

Browse files
committed
catch the filename ones
1 parent 2febae2 commit deb9f63

20 files changed

+118
-170
lines changed

docs/build/reference/assemblylinkresource-link-to-dotnet-framework-resource.md

Lines changed: 2 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,9 @@
11
---
22
description: "Learn more about: /ASSEMBLYLINKRESOURCE (Link to .NET Framework resource)"
33
title: "/ASSEMBLYLINKRESOURCE (Link to .NET Framework resource)"
4-
ms.date: 05/11/2022
4+
ms.date: 03/24/2025
55
f1_keywords: ["/ASSEMBLYLINKRESOURCE", "VC.Project.VCLinkerTool.AssemblyLinkResource"]
66
helpviewer_keywords: ["-ASSEMBLYLINKRESOURCE linker option", "ASSEMBLYLINKRESOURCE linker option", "/ASSEMBLYLINKRESOURCE linker option"]
7-
ms.assetid: 8b6ad184-1b33-47a4-8513-4803cf915b64
87
---
98
# `/ASSEMBLYLINKRESOURCE` (Link to .NET Framework resource)
109

@@ -17,7 +16,7 @@ Create a link to a .NET Framework resource in the output file.
1716
## Arguments
1817

1918
*`filename`*
20-
The .NET Framework resource file to link from the assembly.
19+
The .NET Framework resource file to link from the assembly. Must not exceed `MAX_PATH` (260) characters.
2120

2221
## Remarks
2322

@@ -34,17 +33,11 @@ If *`filename`* is a .NET Framework resource file that's created, for example, b
3433
Other linker options that affect assembly generation are:
3534

3635
- [`/ASSEMBLYDEBUG`](assemblydebug-add-debuggableattribute.md)
37-
3836
- [`/ASSEMBLYMODULE`](assemblymodule-add-a-msil-module-to-the-assembly.md)
39-
4037
- [`/ASSEMBLYRESOURCE`](assemblyresource-embed-a-managed-resource.md)
41-
4238
- [`/DELAYSIGN`](delaysign-partially-sign-an-assembly.md)
43-
4439
- [`/KEYCONTAINER`](keycontainer-specify-a-key-container-to-sign-an-assembly.md)
45-
4640
- [`/KEYFILE`](keyfile-specify-key-or-key-pair-to-sign-an-assembly.md)
47-
4841
- [`/NOASSEMBLY`](noassembly-create-a-msil-module.md)
4942

5043
### To set this linker option in the Visual Studio development environment

docs/build/reference/assemblymodule-add-a-msil-module-to-the-assembly.md

Lines changed: 2 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,9 @@
11
---
22
description: "Learn more about: /ASSEMBLYMODULE (Add an MSIL module to the assembly)"
33
title: "/ASSEMBLYMODULE (Add an MSIL module to the assembly)"
4-
ms.date: 05/11/2022
4+
ms.date: 03/24/2025
55
f1_keywords: ["/assemblymodule", "VC.Project.VCLinkerTool.AddModuleNamesToAssembly"]
66
helpviewer_keywords: ["ASSEMBLYMODULE linker option", "assemblies [C++], adding modules to", "assemblies [C++]", "/ASSEMBLYMODULE linker option", "-ASSEMBLYMODULE linker option"]
7-
ms.assetid: 67357da8-e4b6-49fd-932c-329a5777f143
87
---
98
# `/ASSEMBLYMODULE` (Add an MSIL module to the assembly)
109

@@ -15,7 +14,7 @@ ms.assetid: 67357da8-e4b6-49fd-932c-329a5777f143
1514
### Arguments
1615

1716
*`filename`*\
18-
The module you want to include in this assembly.
17+
The module you want to include in this assembly. Must not exceed `MAX_PATH` (260) characters.
1918

2019
## Remarks
2120

@@ -34,27 +33,19 @@ For example, consider the following scenario:
3433
Other linker options that affect assembly generation are:
3534

3635
- [`/ASSEMBLYDEBUG`](assemblydebug-add-debuggableattribute.md)
37-
3836
- [`/ASSEMBLYLINKRESOURCE`](assemblylinkresource-link-to-dotnet-framework-resource.md)
39-
4037
- [`/ASSEMBLYRESOURCE`](assemblyresource-embed-a-managed-resource.md)
41-
4238
- [`/DELAYSIGN`](delaysign-partially-sign-an-assembly.md)
43-
4439
- [`/NOASSEMBLY`](noassembly-create-a-msil-module.md)
45-
4640
- [`/KEYFILE`](keyfile-specify-key-or-key-pair-to-sign-an-assembly.md)
47-
4841
- [`/KEYCONTAINER`](keycontainer-specify-a-key-container-to-sign-an-assembly.md)
4942

5043
The MSVC linker accepts *`.netmodule`* files as input and the output file produced by the linker will be an assembly or *`.netmodule`* file with no run-time dependence on any of the *`.netmodule`* files that were input to the linker. For more information, see [`.netmodule` files as linker input](netmodule-files-as-linker-input.md).
5144

5245
### To set this linker option in the Visual Studio development environment
5346

5447
1. Open the project's **Property Pages** dialog box. For details, see [Set C++ compiler and build properties in Visual Studio](../working-with-project-properties.md).
55-
5648
1. Select the **Configuration Properties** > **Linker** > **Input** property page.
57-
5849
1. Modify the **Add Module to Assembly** property.
5950

6051
### To set this linker option programmatically

docs/build/reference/assemblyresource-embed-a-managed-resource.md

Lines changed: 2 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,9 @@
11
---
22
description: "Learn more about: /ASSEMBLYRESOURCE (Embed a managed resource)"
33
title: "/ASSEMBLYRESOURCE (Embed a managed resource)"
4-
ms.date: 05/11/2022
4+
ms.date: 03/24/2025
55
f1_keywords: ["VC.Project.VCLinkerTool.EmbedManagedResourceFile", "/ASSEMBLYRESOURCE"]
66
helpviewer_keywords: ["ASSEMBLYRESOURCE linker option", "assemblies [C++]", "-ASSEMBLYRESOURCE linker option", "assemblies [C++], linking resource files", "/ASSEMBLYRESOURCE linker option"]
7-
ms.assetid: 0ce6e1fb-921b-4b1b-a59c-d35388d789f2
87
---
98
# `/ASSEMBLYRESOURCE` (Embed a managed resource)
109

@@ -17,7 +16,7 @@ Embeds a managed resource in an assembly.
1716
## Arguments
1817

1918
*`filename`*\
20-
The managed resource you want to embed in this assembly.
19+
The managed resource you want to embed in this assembly. Must not exceed `MAX_PATH` (260) characters.
2120

2221
*`name`*\
2322
Optional. The logical name for the resource; the name used to load the resource. The default is the name of the file.
@@ -35,17 +34,11 @@ If *`filename`* is a .NET Framework resource (*`.resources`*) file created, for
3534
Other linker options that affect assembly generation are:
3635

3736
- [`/ASSEMBLYDEBUG`](assemblydebug-add-debuggableattribute.md)
38-
3937
- [`/ASSEMBLYLINKRESOURCE`](assemblylinkresource-link-to-dotnet-framework-resource.md)
40-
4138
- [`/ASSEMBLYMODULE`](assemblymodule-add-a-msil-module-to-the-assembly.md)
42-
4339
- [`/DELAYSIGN`](delaysign-partially-sign-an-assembly.md)
44-
4540
- [`/KEYFILE`](keyfile-specify-key-or-key-pair-to-sign-an-assembly.md)
46-
4741
- [`/KEYCONTAINER`](keycontainer-specify-a-key-container-to-sign-an-assembly.md)
48-
4942
- [`/NOASSEMBLY`](noassembly-create-a-msil-module.md)
5043

5144
### To set this linker option in the Visual Studio development environment

docs/build/reference/def-specify-module-definition-file.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,6 @@ title: "/DEF (Specify module-definition file)"
44
ms.date: 09/09/2022
55
f1_keywords: ["VC.Project.VCLinkerTool.ModuleDefinitionFile", "/def"]
66
helpviewer_keywords: ["module definition files, specifying", "DEF linker option", "-DEF linker option", "module definition files", "/DEF linker option"]
7-
ms.assetid: 6497fa68-65f0-48ca-8f66-b87166fc631a
87
---
98
# `/DEF` (Specify module-definition file)
109

@@ -17,7 +16,7 @@ Specifies a module-definition file to the linker.
1716
## Arguments
1817

1918
*`filename`*\
20-
The name of a module-definition file (*`.def`*) to be passed to the linker.
19+
The name of a module-definition file (*`.def`*) to be passed to the linker. Must not exceed `MAX_PATH` (260) characters.
2120

2221
## Remarks
2322

docs/build/reference/genprofile-fastgenprofile-generate-profiling-instrumented-build.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: "/GENPROFILE, /FASTGENPROFILE (Generate Profiling Instrumented Build)"
33
description: "Learn more about: /GENPROFILE, /FASTGENPROFILE (Generate Profiling Instrumented Build)"
4-
ms.date: 04/14/2021
4+
ms.date: 03/24/2025
55
f1_keywords: ["GENPROFILE", "FASTGENPROFILE", "/GENPROFILE", "/FASTGENPROFILE"]
66
helpviewer_keywords: ["GENPROFILE", "FASTGENPROFILE"]
77
---
@@ -43,7 +43,7 @@ Use **`PATH`** to specify a separate set of PGO counters for each unique path t
4343
Specifies whether to use extra counters to keep an accurate count when exceptions are thrown during training. Use **`TRACKEH`** to specify extra counters for an exact count. Use **`NOTRACKEH`** to specify single counters for code that doesn't use exception handling or that doesn't run into exceptions in your training scenarios. When you specify **`/GENPROFILE`**, the default is **`TRACKEH`** . When you specify **`/FASTGENPROFILE`**, the default is **`NOTRACKEH`** .
4444

4545
**`PGD`**=*filename*\
46-
Specifies a base file name for the *`.pgd`* file. By default, the linker uses the base executable image file name with a *`.pgd`* extension.
46+
Specifies a base file name for the *`.pgd`* file. By default, the linker uses the base executable image file name with a *`.pgd`* extension. Must not exceed `MAX_PATH` (260) characters.
4747

4848
## Remarks
4949

docs/build/reference/idlout-name-midl-output-files.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
description: "Learn more about: /IDLOUT (Name MIDL Output Files)"
33
title: "/IDLOUT (Name MIDL Output Files)"
4-
ms.date: "11/04/2016"
4+
ms.date: 03/24/2025
55
f1_keywords: ["/idlout", "VC.Project.VCLinkerTool.MergedIDLBaseFileName"]
66
helpviewer_keywords: ["MIDL, output file names", ".idl files, path", "MIDL", "/IDLOUT linker option", "IDL files, path", "-IDLOUT linker option", "IDLOUT linker option"]
77
---
@@ -17,7 +17,7 @@ helpviewer_keywords: ["MIDL, output file names", ".idl files, path", "MIDL", "/I
1717
An absolute or relative path specification. By specifying a path, you affect only the location of an .idl file; all other files are placed in the project directory.
1818

1919
*`filename`*\
20-
Specifies the name of the .idl file created by the MIDL compiler. No file extension is assumed; specify *filename*.idl if you want an .idl extension. The path and filename must not exceed `MAX_PATH` (260) characters.
20+
Specifies the name of the .idl file created by the MIDL compiler. No file extension is assumed; specify *filename*.idl if you want an .idl extension. The path plus filename must not exceed `MAX_PATH` (260) characters.
2121

2222
## Remarks
2323

docs/build/reference/implib-name-import-library.md

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,28 +4,25 @@ title: "/IMPLIB (Name Import Library)"
44
ms.date: "11/04/2016"
55
f1_keywords: ["/implib", "VC.Project.VCLinkerTool.ImportLIbrary"]
66
helpviewer_keywords: ["IMPLIB linker option", "/IMPLIB linker option", "-IMPLIB linker option", "import libraries, overriding default name"]
7-
ms.assetid: fe8f71ab-7055-41b5-8ef8-2b97cfa4a432
87
---
9-
# /IMPLIB (Name Import Library)
8+
# `/IMPLIB`/ (Name Import Library)
109

1110
> /IMPLIB:*filename*
1211
1312
## Parameters
1413

15-
*filename*<br/>
16-
A user-specified name for the import library. It replaces the default name.
14+
*`filename`*\
15+
A user-specified name for the import library. It replaces the default name. Must not exceed `MAX_PATH` (260) characters.
1716

1817
## Remarks
1918

20-
The /IMPLIB option overrides the default name for the import library that LINK creates when it builds a program that contains exports. The default name is formed from the base name of the main output file and the extension .lib. A program contains exports if one or more of the following are specified:
19+
The `/IMPLIB` option overrides the default name for the import library that LINK creates when it builds a program that contains exports. The default name is formed from the base name of the main output file and the extension .lib. A program contains exports if one or more of the following are specified:
2120

2221
- The [__declspec(dllexport)](../../cpp/dllexport-dllimport.md) keyword in the source code
23-
2422
- [EXPORTS](exports.md) statement in a .def file
25-
2623
- An [/EXPORT](export-exports-a-function.md) specification in a LINK command
2724

28-
LINK ignores /IMPLIB when an import library is not being created. If no exports are specified, LINK does not create an import library. If an export file is used in the build, LINK assumes that an import library already exists and does not create one. For information on import libraries and export files, see [LIB Reference](lib-reference.md).
25+
LINK ignores `/IMPLIB`/ when an import library is not being created. If no exports are specified, LINK does not create an import library. If an export file is used in the build, LINK assumes that an import library already exists and does not create one. For information on import libraries and export files, see [LIB Reference](lib-reference.md).
2926

3027
### To set this linker option in the Visual Studio development environment
3128

@@ -41,5 +38,5 @@ LINK ignores /IMPLIB when an import library is not being created. If no exports
4138

4239
## See also
4340

44-
[MSVC linker reference](linking.md)<br/>
41+
[MSVC linker reference](linking.md)\
4542
[MSVC Linker Options](linker-options.md)
Lines changed: 14 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,52 +1,45 @@
11
---
22
description: "Learn more about: /KEYFILE (Specify Key or Key Pair to Sign an Assembly)"
33
title: "/KEYFILE (Specify Key or Key Pair to Sign an Assembly)"
4-
ms.date: "11/04/2016"
4+
ms.date: 03/24/2025
55
f1_keywords: ["/keyfile", "VC.Project.VCLinkerTool.KeyFile"]
66
helpviewer_keywords: ["/KEYFILE linker option", "-KEYFILE linker option", "KEYFILE linker option"]
7-
ms.assetid: 9b71f8c0-541c-4fe5-a0c7-9364f42ecb06
87
---
98
# /KEYFILE (Specify Key or Key Pair to Sign an Assembly)
109

11-
```
10+
```cmd
1211
/KEYFILE:filename
1312
```
1413

1514
## Arguments
1615

17-
*filename*<br/>
18-
File that contains the key. Place the string in double quotation marks (" ") if it contains a space.
16+
*`filename`*\
17+
File that contains the key. Place the string in double quotation marks (" ") if it contains a space. Must not exceed `MAX_PATH` (260) characters.
1918

2019
## Remarks
2120

22-
The linker inserts the public key into the assembly manifest and then signs the final assembly with the private key. To generate a key file, type [sn -k](/dotnet/framework/tools/sn-exe-strong-name-tool) *filename* at the command line. A signed assembly is said to have a strong name.
21+
The linker inserts the public key into the assembly manifest and then signs the final assembly with the private key. To generate a key file, type [`sn -k`](/dotnet/framework/tools/sn-exe-strong-name-tool) *filename* at the command line. A signed assembly is said to have a strong name.
2322

24-
If you compile with [/LN](ln-create-msil-module.md), the name of the key file is held in the module and incorporated into the assembly that is created when you compile an assembly that includes an explicit reference to the module, via [#using](../../preprocessor/hash-using-directive-cpp.md), or when linking with [/ASSEMBLYMODULE](assemblymodule-add-a-msil-module-to-the-assembly.md).
23+
If you compile with [`/LN`](ln-create-msil-module.md), the name of the key file is held in the module and incorporated into the assembly that is created when you compile an assembly that includes an explicit reference to the module, via [`#using`](../../preprocessor/hash-using-directive-cpp.md), or when linking with `[/ASSEMBLYMODULE`](assemblymodule-add-a-msil-module-to-the-assembly.md).
2524

26-
You can also pass your encryption information to the linker with [/KEYCONTAINER](keycontainer-specify-a-key-container-to-sign-an-assembly.md). Use [/DELAYSIGN](delaysign-partially-sign-an-assembly.md) if you want a partially signed assembly. For more information on signing an assembly, see [Strong Name Assemblies (Assembly Signing) (C++/CLI)](../../dotnet/strong-name-assemblies-assembly-signing-cpp-cli.md) and [Creating and Using Strong-Named Assemblies](/dotnet/framework/app-domains/create-and-use-strong-named-assemblies).
25+
You can also pass your encryption information to the linker with [`/KEYCONTAINER`](keycontainer-specify-a-key-container-to-sign-an-assembly.md). Use [`/DELAYSIGN`](delaysign-partially-sign-an-assembly.md) if you want a partially signed assembly. For more information on signing an assembly, see [Strong Name Assemblies (Assembly Signing) (C++/CLI)](../../dotnet/strong-name-assemblies-assembly-signing-cpp-cli.md) and [Creating and Using Strong-Named Assemblies](/dotnet/framework/app-domains/create-and-use-strong-named-assemblies).
2726

28-
In case both **/KEYFILE** and **/KEYCONTAINER** are specified (either by command-line option or by custom attribute), the linker will first try the key container. If that succeeds, then the assembly is signed with the information in the key container. If the linker doesn't find the key container, it will try the file specified with /KEYFILE. If that succeeds, the assembly is signed with the information in the key file and the key information will be installed in the key container (similar to sn -i) so that on the next compilation, the key container will be valid.
27+
In case both **`/KEYFILE`** and **`/KEYCONTAINER`** are specified (either by command-line option or by custom attribute), the linker will first try the key container. If that succeeds, then the assembly is signed with the information in the key container. If the linker doesn't find the key container, it will try the file specified with /KEYFILE. If that succeeds, the assembly is signed with the information in the key file and the key information will be installed in the key container (similar to sn -i) so that on the next compilation, the key container will be valid.
2928

3029
A key file might contain only the public key.
3130

3231
Other linker options that affect assembly generation are:
3332

34-
- [/ASSEMBLYDEBUG](assemblydebug-add-debuggableattribute.md)
35-
36-
- [/ASSEMBLYLINKRESOURCE](assemblylinkresource-link-to-dotnet-framework-resource.md)
37-
38-
- [/ASSEMBLYMODULE](assemblymodule-add-a-msil-module-to-the-assembly.md)
39-
40-
- [/ASSEMBLYRESOURCE](assemblyresource-embed-a-managed-resource.md)
41-
42-
- [/NOASSEMBLY](noassembly-create-a-msil-module.md)
33+
- [/`ASSEMBLYDEBUG`](assemblydebug-add-debuggableattribute.md)
34+
- [`/ASSEMBLYLINKRESOURCE`](assemblylinkresource-link-to-dotnet-framework-resource.md)
35+
- [`/ASSEMBLYMODULE`](assemblymodule-add-a-msil-module-to-the-assembly.md)
36+
- [`/ASSEMBLYRESOURCE`](assemblyresource-embed-a-managed-resource.md)
37+
- [`/NOASSEMBLY`](noassembly-create-a-msil-module.md)
4338

4439
### To set this linker option in the Visual Studio development environment
4540

4641
1. Open the project's **Property Pages** dialog box. For details, see [Set C++ compiler and build properties in Visual Studio](../working-with-project-properties.md).
47-
4842
1. Select the **Configuration Properties** > **Linker** > **Command Line** property page.
49-
5043
1. Enter the option into the **Additional Options** box.
5144

5245
### To set this linker option programmatically
@@ -55,5 +48,5 @@ Other linker options that affect assembly generation are:
5548

5649
## See also
5750

58-
[MSVC linker reference](linking.md)<br/>
51+
[MSVC linker reference](linking.md)\
5952
[MSVC Linker Options](linker-options.md)

docs/build/reference/manifestfile-name-manifest-file.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,21 @@
11
---
22
description: "Learn more about: /MANIFESTFILE (Name Manifest File)"
33
title: "/MANIFESTFILE (Name Manifest File)"
4-
ms.date: "11/04/2016"
4+
ms.date: 03/24/2025
55
f1_keywords: ["VC.Project.VCLinkerTool.ManifestFile"]
66
helpviewer_keywords: ["MANIFESTFILE linker option", "-MANIFESTFILE linker option", "/MANIFESTFILE linker option"]
7-
ms.assetid: befa5ab2-a9cf-4c9b-969a-e7b4a930f08d
87
---
98
# /MANIFESTFILE (Name Manifest File)
109

11-
```
10+
```cmd
1211
/MANIFESTFILE:filename
1312
```
1413

1514
## Remarks
1615

17-
/MANIFESTFILE lets you change the default name of the manifest file. The default name of the manifest file is the file name with .manifest appended.
16+
Specify `/MANIFESTFILE` to change the default name of the manifest file. The default name of the manifest file is `filename` with `.manifest` appended. The resulting manifest file name must not exceed `MAX_PATH` (260) characters.
1817

19-
/MANIFESTFILE will have no effect if you do not also link with [/MANIFEST](manifest-create-side-by-side-assembly-manifest.md).
18+
`/MANIFESTFILE` has no effect if you do not also link with [`/MANIFEST`](manifest-create-side-by-side-assembly-manifest.md).
2019

2120
### To set this linker option in the Visual Studio development environment
2221

@@ -32,5 +31,5 @@ ms.assetid: befa5ab2-a9cf-4c9b-969a-e7b4a930f08d
3231

3332
## See also
3433

35-
[MSVC linker reference](linking.md)<br/>
34+
[MSVC linker reference](linking.md)\
3635
[MSVC Linker Options](linker-options.md)

0 commit comments

Comments
 (0)