Merge pull request #5846 from TylerMSFT/linker

specify MAX_PATH limitation

Author: JillGrant615

docs/build/reference/base-base-address.md

@@ -1,10 +1,9 @@
 ---
 description: "Learn more about: /BASE (Base address)"
 title: "/BASE (Base address)"
-ms.date: 05/11/2022
+ms.date: 03/27/2025
 f1_keywords: ["/base", "VC.Project.VCLinkerTool.BaseAddress"]
 helpviewer_keywords: ["base addresses [C++]", "programs [C++], preventing relocation", "semicolon [C++], specifier", "-BASE linker option", "key address size", "environment variables [C++], LIB", "programs [C++], base address", "LIB environment variable", "BASE linker option", "DLLs [C++], linking", "/BASE linker option", "@ symbol for base address", "executable files [C++], base address", "at sign symbol for base address"]
-ms.assetid: 00b9f6fe-0bd2-4772-a69c-7365eb199069
 ---
 # `/BASE` (Base address)
 
@@ -23,7 +22,7 @@ The **`/BASE`** linker option sets a base address for the program. It overrides
 
 The linker issues an error if *`address`* isn't a multiple of 64K. You can optionally specify the size of the program. The linker issues a warning if the program can't fit in the size you specified.
 
-On the command line, another way to specify the base address is by using a *base address response file*. A base address response file is a text file that contains the base addresses and optional sizes of all the DLLs your program uses, and a unique text key for each base address. To specify a base address by using a response file, use an at sign (**`@`**) followed by the name of the response file, *`filename`*, followed by a comma, then the *`key`* value for the base address to use in the file. The linker looks for *`filename`* in either the specified path, or if no path is specified, in the directories specified in the `LIB` environment variable. Each line in *`filename`* represents one DLL and has the following syntax:
+On the command line, another way to specify the base address is by using a *base address response file*. A base address response file is a text file that contains the base addresses and optional sizes of all the DLLs your program uses, and a unique text key for each base address. To specify a base address by using a response file, use an at sign (**`@`**) followed by the name of the response file, *`filename`*, followed by a comma, then the *`key`* value for the base address to use in the file. The linker looks for *`filename`* in either the specified path, or if no path is specified, in the directories specified in the `LIB` environment variable. The fully qualified *`filename`* must not exceed `MAX_PATH` (260 characters). Each line in *`filename`* represents one DLL and has the following syntax:
 
 > *`key`* *`address`* \[*`size`*] **`;`** *`comment`*
 
@@ -35,7 +34,7 @@ one    0x28000000    0x00100000    ; for DLLONE.DLL
 two    0x28100000    0x00300000    ; for DLLTWO.DLL
 ```
 
-If the file that contains these lines is called DLLS.txt, the following example command applies this information:
+If the file that contains these lines is called `DLLS.txt`, the following example command applies this information:
 
 ```cmd
 link dlltwo.obj /dll /base:@dlls.txt,two
@@ -46,9 +45,7 @@ Another way to set the base address is by using the *`BASE`* argument in a [`NAM
 ### To set this linker option in the Visual Studio development environment
 
 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).
-
 1. Select the **Configuration Properties** > **Linker** > **Advanced** property page.
-
 1. Modify the **Base Address** property.
 
 ### To set this linker option programmatically

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

@@ -1,10 +1,9 @@
 ---
 description: "Learn more about: /DEF (Specify module-definition file)"
 title: "/DEF (Specify module-definition file)"
-ms.date: 09/09/2022
+ms.date: 03/27/2025
 f1_keywords: ["VC.Project.VCLinkerTool.ModuleDefinitionFile", "/def"]
 helpviewer_keywords: ["module definition files, specifying", "DEF linker option", "-DEF linker option", "module definition files", "/DEF linker option"]
-ms.assetid: 6497fa68-65f0-48ca-8f66-b87166fc631a
 ---
 # `/DEF` (Specify module-definition file)
 
@@ -17,7 +16,7 @@ Specifies a module-definition file to the linker.
 ## Arguments
 
 *`filename`*\
-The name of a module-definition file (*`.def`*) to be passed to the linker.
+The name of a module-definition file (*`.def`*) to be passed to the linker. When expanded, the fully qualified filename must not exceed `MAX_PATH` (260 characters).
 
 ## Remarks
 
@@ -28,9 +27,7 @@ To specify a *`.def`* file from within the development environment, add it to th
 ### To set this linker option in the Visual Studio development environment
 
 1. Open the project's **Property Pages** dialog box. For more information, see [Set compiler and build properties](../working-with-project-properties.md).
-
 1. Select the **Configuration Properties** > **Linker** > **Input** property page.
-
 1. Modify the **Module Definition File** property. Choose **OK** or **Apply** to save your changes.
 
 ### To set this linker option programmatically

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

@@ -1,7 +1,7 @@
 ---
 title: "/GENPROFILE, /FASTGENPROFILE (Generate Profiling Instrumented Build)"
 description: "Learn more about: /GENPROFILE, /FASTGENPROFILE (Generate Profiling Instrumented Build)"
-ms.date: 04/14/2021
+ms.date: 03/27/2025
 f1_keywords: ["GENPROFILE", "FASTGENPROFILE", "/GENPROFILE", "/FASTGENPROFILE"]
 helpviewer_keywords: ["GENPROFILE", "FASTGENPROFILE"]
 ---
@@ -43,7 +43,7 @@ Use **`PATH`**  to specify a separate set of PGO counters for each unique path t
 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`** .
 
 **`PGD`**=*filename*\
-Specifies a base file name for the *`.pgd`* file. By default, the linker uses the base executable image file name with a *`.pgd`* extension.
+Specifies a base filename for the *`.pgd`* file. By default, the linker uses the base executable image filename with a *`.pgd`* extension. When expanded, the fully qualified filename must not exceed `MAX_PATH` (260 characters).
 
 ## Remarks
 

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

@@ -1,51 +1,45 @@
 ---
 description: "Learn more about: /IDLOUT (Name MIDL Output Files)"
 title: "/IDLOUT (Name MIDL Output Files)"
-ms.date: "11/04/2016"
+ms.date: 03/27/2025
 f1_keywords: ["/idlout", "VC.Project.VCLinkerTool.MergedIDLBaseFileName"]
 helpviewer_keywords: ["MIDL, output file names", ".idl files, path", "MIDL", "/IDLOUT linker option", "IDL files, path", "-IDLOUT linker option", "IDLOUT linker option"]
-ms.assetid: 10d00a6a-85b4-4de1-8732-e422c6931509
 ---
 # /IDLOUT (Name MIDL Output Files)
 
-```
-/IDLOUT:[path\]filename
-```
+## Syntax
 
-## Parameters
+> /IDLOUT:[path\]filename
 
-*path*<br/>
-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.
+## Argument
 
-*filename*<br/>
-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.
+*`path`*\
+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.
+
+*`filename`*\
+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. When expanded, the fully qualified filename must not exceed `MAX_PATH` (260 characters).
 
 ## Remarks
 
-The /IDLOUT option specifies the name and extension of the .idl file.
+The `/IDLOUT` option specifies the name and extension of the `.idl `file.
 
-The MIDL compiler is called by the MSVC linker when linking projects that have the [module](../../windows/attributes/module-cpp.md) attribute.
+The MIDL compiler is called by the MSVC linker when linking projects that have the [`module`](../../windows/attributes/module-cpp.md) attribute.
 
-/IDLOUT also specifies the file names of the other output files associated with the MIDL compiler:
+`/IDLOUT` also specifies the file names of the other output files associated with the MIDL compiler:
 
 - *filename*.tlb
-
 - *filename*_p.c
-
 - *filename*_i.c
-
 - *filename*.h
 
-*filename* is the parameter that you pass to /IDLOUT. If [/TLBOUT](tlbout-name-dot-tlb-file.md) is specified, the .tlb file will get its name from /TLBOUT *filename*.
+*`filename`* is the parameter that you pass to `/IDLOUT`. If [`/TLBOUT`](tlbout-name-dot-tlb-file.md) is specified, the .tlb file will get its name from `/TLBOUT` *`filename`*.
 
-If you specify neither /IDLOUT nor /TLBOUT, the linker will create vc70.tlb, vc70.idl, vc70_p.c, vc70_i.c, and vc70.h.
+If you specify neither `/IDLOUT` nor `/TLBOUT`, the linker will create vc70.tlb, vc70.idl, vc70_p.c, vc70_i.c, and vc70.h.
 
 ### To set this linker option in the Visual Studio development environment
 
 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).
-
 1. Select the **Configuration Properties** > **Linker** > **Embedded IDL** property page.
-
 1. Modify the **Merge IDL Base File Name** property.
 
 ### To set this linker option programmatically
@@ -54,8 +48,8 @@ If you specify neither /IDLOUT nor /TLBOUT, the linker will create vc70.tlb, vc7
 
 ## See also
 
-[MSVC linker reference](linking.md)<br/>
-[MSVC Linker Options](linker-options.md)<br/>
-[/IGNOREIDL (Don't Process Attributes into MIDL)](ignoreidl-don-t-process-attributes-into-midl.md)<br/>
-[/MIDL (Specify MIDL Command Line Options)](midl-specify-midl-command-line-options.md)<br/>
+[MSVC linker reference](linking.md)\
+[MSVC Linker Options](linker-options.md)\
+[/IGNOREIDL (Don't Process Attributes into MIDL)](ignoreidl-don-t-process-attributes-into-midl.md)\
+[/MIDL (Specify MIDL Command Line Options)](midl-specify-midl-command-line-options.md)\
 [Building an Attributed Program](../../windows/attributes/cpp-attributes-com-net.md)

docs/build/reference/ilk-name-incremental-database-file.md

@@ -1,7 +1,7 @@
 ---
 title: "/ILK (Name incremental database file)"
 description: "The MSVC linker option /ILK specifies the incremental link database file pathname."
-ms.date: 09/07/2022
+ms.date: 03/27/2025
 f1_keywords: ["VC.Project.VCLinkerTool.IncrementalLinkDatabaseFile", "/ilk", "ilk"]
 helpviewer_keywords: ["Name incremental database file in C++ linker", "/ILK linker option", "-ILK linker option", "ILK linker option"]
 ---
@@ -16,7 +16,7 @@ The **`/ILK`** linker option tells the linker where to put the *`.ilk`* database
 ### Arguments
 
 *`pathname`*\
-The destination directory and filename for the generated *`.ilk`* file. If the **`/ILK`** option isn't specified when **`/INCREMENTAL`** is used, the filename is created by appending *`.ilk`* to the target base filename.
+The destination directory and filename for the generated *`.ilk`* file. If the **`/ILK`** option isn't specified when **`/INCREMENTAL`** is used, the filename is created by appending *`.ilk`* to the target base filename. When expanded, the fully qualified filename must not exceed `MAX_PATH` (260 characters).
 
 ## Remarks
 
@@ -25,9 +25,7 @@ The **`/ILK`** linker option tells the linker the path and filename to use for t
 ### To set this compiler option in the Visual Studio development environment
 
 1. Open the project **Property Pages** dialog box. For more information, see [Set compiler and build properties](../working-with-project-properties.md).
-
 1. Select the **Configuration Properties** > **Linker** > **General** property page.
-
 1. Modify the **Incremental Link Database File** property. The default value is `$(IntDir)$(TargetName).ilk`.
 
 ### To set this compiler option programmatically

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

@@ -1,38 +1,35 @@
 ---
 description: "Learn more about: /IMPLIB (Name Import Library)"
 title: "/IMPLIB (Name Import Library)"
-ms.date: "11/04/2016"
+ms.date: 03/24/2025
 f1_keywords: ["/implib", "VC.Project.VCLinkerTool.ImportLIbrary"]
 helpviewer_keywords: ["IMPLIB linker option", "/IMPLIB linker option", "-IMPLIB linker option", "import libraries, overriding default name"]
-ms.assetid: fe8f71ab-7055-41b5-8ef8-2b97cfa4a432
 ---
-# /IMPLIB (Name Import Library)
+# `/IMPLIB` (Name Import Library)
+
+## Syntax
 
 > /IMPLIB:*filename*
 
-## Parameters
+## Argument
 
-*filename*<br/>
-A user-specified name for the import library. It replaces the default name.
+*`filename`*\
+A user-specified name for the import library. It replaces the default name. When expanded, the fully qualified filename must not exceed `MAX_PATH` (260 characters).
 
 ## Remarks
 
-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:
+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:
 
 - The [__declspec(dllexport)](../../cpp/dllexport-dllimport.md) keyword in the source code
-
 - [EXPORTS](exports.md) statement in a .def file
-
 - An [/EXPORT](export-exports-a-function.md) specification in a LINK command
 
-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).
+LINK ignores `/IMPLIB` when an import library isn't being created. If no exports are specified, LINK doesn't create an import library. If an export file is used in the build, LINK assumes that an import library already exists and doesn't create one. For information on import libraries and export files, see [LIB Reference](lib-reference.md).
 
 ### To set this linker option in the Visual Studio development environment
 
 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).
-
 1. Select the **Configuration Properties** > **Linker** > **Advanced** property page.
-
 1. Modify the **Import Library** property.
 
 ### To set this linker option programmatically
@@ -41,5 +38,5 @@ LINK ignores /IMPLIB when an import library is not being created. If no exports
 
 ## See also
 
-[MSVC linker reference](linking.md)<br/>
+[MSVC linker reference](linking.md)\
 [MSVC Linker Options](linker-options.md)