Add "Remarks" and "Example" headings for error references in range [LNK1221, LNK2000]

Rageking8 · web-flow · commit 9f000cf993b9 · 2025-09-21T17:52:00.000+08:00
diff --git a/docs/error-messages/tool-errors/linker-tools-error-lnk1221.md b/docs/error-messages/tool-errors/linker-tools-error-lnk1221.md
@@ -10,6 +10,8 @@ ms.assetid: 70654bf9-1520-4fa3-a063-1219dd88abf7
 
 > a subsystem can't be inferred and must be defined
 
+## Remarks
+
 The linker does not have enough information to infer which subsystem you want to target.
 
 To fix this error, use [/SUBSYSTEM](../../build/reference/subsystem-specify-subsystem.md).
diff --git a/docs/error-messages/tool-errors/linker-tools-error-lnk1223.md b/docs/error-messages/tool-errors/linker-tools-error-lnk1223.md
@@ -10,6 +10,8 @@ ms.assetid: c4728c36-daee-462f-a1c7-8733dcdec88e
 
 > invalid or corrupt file: file contains invalid .pdata contributions
 
+## Remarks
+
 For RISC platforms that use pdata, this error will occur if the compiler emitted a .pdata section with unsorted entries.
 
 To fix this issue, try compiling without [/GL (Whole Program Optimization)](../../error-messages/tool-errors/linker-tools-error-lnk1223.md) enabled. Empty function bodies can also cause this error in some cases.
diff --git a/docs/error-messages/tool-errors/linker-tools-error-lnk1224.md b/docs/error-messages/tool-errors/linker-tools-error-lnk1224.md
@@ -10,4 +10,6 @@ ms.assetid: e190b5d0-ce0c-4f65-8cc0-753f1cc9758a
 
 > invalid image base address
 
+## Remarks
+
 You specified an invalid base address for the image. Base addresses must be 64KB aligned (the last four hex digits must be zero) and image base must fit within a 32-bit signed or unsigned value.
diff --git a/docs/error-messages/tool-errors/linker-tools-error-lnk1240.md b/docs/error-messages/tool-errors/linker-tools-error-lnk1240.md
@@ -10,4 +10,6 @@ ms.assetid: 7d0e065d-1015-4df0-8370-79c3cf045e1c
 
 > failed to compile IDL content
 
+## Remarks
+
 The linker spawned MIDL to compile embedded IDL but there was a problem. Check the errors specified by MIDL.
diff --git a/docs/error-messages/tool-errors/linker-tools-error-lnk1241.md b/docs/error-messages/tool-errors/linker-tools-error-lnk1241.md
@@ -10,6 +10,8 @@ ms.assetid: 7b8b52eb-0231-4521-b52a-2bce8d3e8956
 
 > resource file 'resource file' already specified
 
+## Remarks
+
 This error is generated if you run **cvtres** manually from the command line and if you then pass the resulting .obj file to the linker in addition to other .res files.
 
 To specify multiple .res files, pass them all to the linker as .res files, not from within .obj files created by **cvtres**.
diff --git a/docs/error-messages/tool-errors/linker-tools-error-lnk1245.md b/docs/error-messages/tool-errors/linker-tools-error-lnk1245.md
@@ -10,6 +10,8 @@ ms.assetid: 179c8165-ffbb-44cd-9f24-5250f29577cc
 
 > invalid subsystem 'subsystem' specified; /SUBSYSTEM must be WINDOWS, WINDOWSCE, or CONSOLE
 
+## Remarks
+
 [/clr](../../build/reference/clr-common-language-runtime-compilation.md) was used to compile the object and one of the following conditions was true:
 
 - A custom entry point was defined ([/ENTRY](../../build/reference/entry-entry-point-symbol.md)), such that, the linker could not infer a subsystem.
diff --git a/docs/error-messages/tool-errors/linker-tools-error-lnk1256.md b/docs/error-messages/tool-errors/linker-tools-error-lnk1256.md
@@ -10,12 +10,16 @@ ms.assetid: 55b64b2b-a56b-436c-a55e-ec9c6dcb050e
 
 > ALINK operation failed : reason
 
+## Remarks
+
 A common reason for LNK1256 is an incorrect version number for an assembly. The value 65535 is not allowed for any part of the assembly version number. The valid range for assembly versions is 0 - 65534.
 
 LNK1256 can also be caused if ALINK could not find the named key container. Delete the key container and add it again to the strong name CSP by using [Sn.exe (Strong Name Tool)](/dotnet/framework/tools/sn-exe-strong-name-tool).
 
 Another reason for LNK1256 is a version mismatch between the linker and Alink.dll. This can be caused by a corrupted Visual Studio installation. Use **Programs and Features** in the Windows Control Panel to repair or reinstall Visual Studio.
 
+## Example
+
 The following sample generates LNK1256:
 
 ```cpp
diff --git a/docs/error-messages/tool-errors/linker-tools-error-lnk1264.md b/docs/error-messages/tool-errors/linker-tools-error-lnk1264.md
@@ -10,6 +10,8 @@ ms.assetid: 23b1aad7-d382-42c1-bae8-db68575c57a8
 
 > /LTCG:PGINSTRUMENT specified but no code generation required; instrumentation failed
 
+## Remarks
+
 **/LTCG:PGINSTRUMENT** was specified but no .obj files were found that were compiled with [/GL](../../build/reference/gl-whole-program-optimization.md). Instrumentation cannot take place and the link failed. There must be at least one .obj file on the command line that is compiled with **/GL** so that the instrumentation can occur.
 
 Profile guided optimization (PGO) is only available in 64-bit compilers.
diff --git a/docs/error-messages/tool-errors/linker-tools-error-lnk1277.md b/docs/error-messages/tool-errors/linker-tools-error-lnk1277.md
@@ -10,6 +10,8 @@ ms.assetid: afca3de0-50cc-4140-af7a-13493a170835
 
 > object record not found in pgd (filename)
 
+## Remarks
+
 When using [/LTCG:PGOPTIMZE](../../build/reference/ltcg-link-time-code-generation.md), the path of one of the input .lib, def, or .obj files was different from the path on which they were found during /LTCG:PGINSTRUMENT. This may be explained by a change in the LIB environment variable after /LTCG:PGINSTRUMENT. The full path to the input files is stored in the .pgd file.
 
 /LTCG:PGOPTIMIZE requires that the inputs be identical to the /LTCG:PGINSTRUMENT phase.
diff --git a/docs/error-messages/tool-errors/linker-tools-error-lnk1282.md b/docs/error-messages/tool-errors/linker-tools-error-lnk1282.md
@@ -10,4 +10,6 @@ ms.assetid: 99c13f52-eb80-46ce-a5b9-4537583e32a9
 
 > unable to /REBASE file; it has been signed
 
+## Remarks
+
 You attempted to change the base address of a signed assembly with the /REBASE option for [editbin](../../build/reference/editbin-reference.md). To do this, first change the base address and then sign the assembly.
diff --git a/docs/error-messages/tool-errors/linker-tools-error-lnk1287.md b/docs/error-messages/tool-errors/linker-tools-error-lnk1287.md
@@ -10,4 +10,6 @@ ms.assetid: 48dc379d-370c-42f6-8028-5bbcf1cc88bd
 
 > invalid managed entry point function
 
+## Remarks
+
 The entry point is not valid for a managed image. The return type of a managed entry point function can only be **`void`** or **`int`**. The type of the parameter of a managed entry point function can only be **`void`** or `String []`.
diff --git a/docs/error-messages/tool-errors/linker-tools-error-lnk1296.md b/docs/error-messages/tool-errors/linker-tools-error-lnk1296.md
@@ -10,6 +10,8 @@ ms.assetid: f94a3d18-5411-456b-966f-89810fdcfe60
 
 > unable to load filename
 
+## Remarks
+
 The given DLL was unavailable.
 
 The possible locations for the DLL are the current directory, the system directory, the Windows directory, and the directories specified in the PATH environment variable.
diff --git a/docs/error-messages/tool-errors/linker-tools-error-lnk1301.md b/docs/error-messages/tool-errors/linker-tools-error-lnk1301.md
@@ -10,6 +10,8 @@ ms.assetid: 760da428-7182-4b25-b20a-de90d4b9a9cd
 
 > LTCG clr modules found, incompatible with /LTCG:parameter
 
+## Remarks
+
 A module compiled with /clr and /GL was passed to the linker along with one of the profile guided optimizations (PGO) parameters of /LTCG.
 
 Profile guided optimizations are not supported for /clr modules.
diff --git a/docs/error-messages/tool-errors/linker-tools-error-lnk1302.md b/docs/error-messages/tool-errors/linker-tools-error-lnk1302.md
@@ -10,6 +10,8 @@ ms.assetid: aea3c753-c2c4-4249-bbc3-f2d4f0164b5e
 
 > only support linking safe .netmodules; unable to link file .netmodule
 
+## Remarks
+
 A .netmodule (compiled with **/LN**) was passed to the linker in a user attempt to invoke MSIL linking.  A C++ module is valid for MSIL linking if it is compiled with **/clr:safe**.
 
 To correct this error, compile with **/clr:safe** to enable MSIL linking, or pass the **/clr** or **/clr:pure** .obj file to the linker instead of the module.
diff --git a/docs/error-messages/tool-errors/linker-tools-error-lnk1306.md b/docs/error-messages/tool-errors/linker-tools-error-lnk1306.md
@@ -10,6 +10,8 @@ ms.assetid: fad1df6a-0bd9-412f-b0d1-7c9bc749c584
 
 > DLL entry point function cannot be managed; compile to native
 
+## Remarks
+
 `DllMain` cannot be compiled to MSIL; it must be compiled to native.
 
 To resolve this issue,
diff --git a/docs/error-messages/tool-errors/linker-tools-error-lnk1312.md b/docs/error-messages/tool-errors/linker-tools-error-lnk1312.md
@@ -10,9 +10,11 @@ ms.assetid: 48284abb-d849-43fc-ab53-45aded14fd8a
 
 > invalid or corrupt file: unable to import assembly
 
+## Remarks
+
 When building an assembly, a file other than a module or assembly compiled with **/clr** was passed to the **/ASSEMBLYMODULE** linker option.  If you passed an object file to **/ASSEMBLYMODULE**, just pass the object directly to the linker, instead of to **/ASSEMBLYMODULE**.
 
-## Examples
+## Example
 
 The following sample created the .obj file.
 
diff --git a/docs/error-messages/tool-errors/linker-tools-error-lnk1313.md b/docs/error-messages/tool-errors/linker-tools-error-lnk1313.md
@@ -16,7 +16,7 @@ The current version of Visual C++ does not support linking native or mixed manag
 
 The **`/clr:pure`** compiler option is deprecated in Visual Studio 2015 and unsupported in Visual Studio 2017 and later.
 
-## Examples
+## Example
 
 Source file `LNK1313.cpp`:
 
diff --git a/docs/error-messages/tool-errors/linker-tools-error-lnk1314.md b/docs/error-messages/tool-errors/linker-tools-error-lnk1314.md
@@ -10,6 +10,8 @@ ms.assetid: 0b5cd599-61ea-4ac7-8f25-c6d3a8b14655
 
 > corrupt or invalid COFF symbol table (undefined static or label symbol)
 
+## Remarks
+
 The compiler-generated content for a section in the given object appears to be corrupt.
 
 This error may represent a failure of the compiler.
diff --git a/docs/error-messages/tool-errors/linker-tools-error-lnk1318.md b/docs/error-messages/tool-errors/linker-tools-error-lnk1318.md
@@ -9,6 +9,8 @@ helpviewer_keywords: ["LNK1318"]
 
 > Unexpected PDB error; *cause* '*details*'
 
+## Remarks
+
 The linker encountered an unexpected error when opening, reading, or writing to a PDB file.
 
 This error message is produced for uncommon issues in PDB files. The *cause* and *details* represent the information available to the linker when the failure occurred. This may not be very useful, as common errors when dealing with PDB files have separate, more informative error messages.
diff --git a/docs/error-messages/tool-errors/linker-tools-error-lnk1332.md b/docs/error-messages/tool-errors/linker-tools-error-lnk1332.md
@@ -10,6 +10,8 @@ ms.assetid: b31d5ca0-c27f-4177-896b-2637dccbde24
 
 > detected\<count> Windows Runtime types imported in one module and defined in another module
 
+## Remarks
+
 When it produced the current target, the linker detected <`count`> Windows Runtime types, each of which is imported in one module and also defined in another module.
 
 ### To correct this error
diff --git a/docs/error-messages/tool-errors/linker-tools-error-lnk1561.md b/docs/error-messages/tool-errors/linker-tools-error-lnk1561.md
@@ -10,6 +10,8 @@ ms.assetid: cb0b709b-7c9c-4496-8a4e-9e1e4aefe447
 
 > entry point must be defined
 
+## Remarks
+
 The linker did not find an *entry point*, the initial function to call in your executable. By default, the linker looks for a `main` or `wmain` function for a console app, a `WinMain` or `wWinMain` function for a Windows app, or `DllMain` for a DLL that requires initialization. You can specify another function by using the [/ENTRY](../../build/reference/entry-entry-point-symbol.md) linker option.
 
 This error can have several causes:
