Skip to content

Update buffer size notes for (Sym)FindExecutableImage(Ex)(W) #2013

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 12 commits into
base: docs
Choose a base branch
from
Open
4 changes: 2 additions & 2 deletions sdk-api-src/content/dbghelp/nf-dbghelp-finddebuginfofile.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ The path where symbol files are located. This can be multiple paths separated by

### -param DebugFilePath [out]

A pointer to a buffer that receives the full path of the .dbg file.
A pointer to a buffer that receives the full path of the .dbg file. This buffer must be at least MAX_PATH+1 characters.

## -returns

Expand All @@ -95,4 +95,4 @@ All DbgHelp functions, such as this one, are single threaded. Therefore, calls f



<a href="/windows/desktop/api/dbghelp/nf-dbghelp-symgetsearchpath">SymGetSearchPath</a>
<a href="/windows/desktop/api/dbghelp/nf-dbghelp-symgetsearchpath">SymGetSearchPath</a>
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ The path where symbol files are located. This can be multiple paths separated by

### -param DebugFilePath [out]

A pointer to a buffer that receives the full path of the .dbg file.
A pointer to a buffer that receives the full path of the .dbg file. This buffer must be at least MAX_PATH+1 characters.

### -param Callback [in, optional]

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ The path where symbol files are located. This can be multiple paths separated by

### -param DebugFilePath [out]

A pointer to a buffer that receives the full path of the .dbg file.
A pointer to a buffer that receives the full path of the .dbg file. This buffer must be at least MAX_PATH+1 characters.

### -param Callback [in, optional]

Expand Down
4 changes: 2 additions & 2 deletions sdk-api-src/content/dbghelp/nf-dbghelp-findexecutableimage.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ The path where symbol files are located. This can be multiple paths separated by

### -param ImageFilePath [out]

A pointer to a buffer that receives the full path of the executable file.
A pointer to a buffer that receives the full path of the executable file. This buffer must be at least MAX_PATH+1 characters.

## -returns

Expand All @@ -94,4 +94,4 @@ All DbgHelp functions, such as this one, are single threaded. Therefore, calls f



<a href="/windows/desktop/api/dbghelp/nf-dbghelp-symgetsearchpath">SymGetSearchPath</a>
<a href="/windows/desktop/api/dbghelp/nf-dbghelp-symgetsearchpath">SymGetSearchPath</a>
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ The path where symbol files are located. This string can contain multiple paths

### -param ImageFilePath [out]

A pointer to a buffer that receives the full path of the executable file.
A pointer to a buffer that receives the full path of the executable file. This buffer must be at least MAX_PATH+1 characters.

### -param Callback [in, optional]

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ The path where symbol files are located. This string can contain multiple paths

### -param ImageFilePath [out]

A pointer to a buffer that receives the full path of the executable file.
A pointer to a buffer that receives the full path of the executable file. This buffer must be at least MAX_PATH+1 characters.

### -param Callback [in, optional]

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ The name of the .dbg file. You can use a partial path.

### -param DebugFilePath [out]

The fully qualified path of the .dbg file. This buffer must be at least MAX_PATH characters.
The fully qualified path of the .dbg file. This buffer must be at least MAX_PATH+1 characters.

### -param Callback [in, optional]

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ The name of the .dbg file. You can use a partial path.

### -param DebugFilePath [out]

The fully qualified path of the .dbg file. This buffer must be at least MAX_PATH characters.
The fully qualified path of the .dbg file. This buffer must be at least MAX_PATH+1 characters.

### -param Callback [in, optional]

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ The name of the executable file. You can use a partial path.

### -param ImageFilePath [out]

The fully qualified path of the executable file. This buffer must be at least MAX_PATH characters.
The fully qualified path of the executable file. This buffer must be at least MAX_PATH+1 characters.

### -param Callback [in]

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ The name of the executable file. You can use a partial path.

### -param ImageFilePath [out]

The fully qualified path of the executable file. This buffer must be at least MAX_PATH characters.
The fully qualified path of the executable file. This buffer must be at least MAX_PATH+1 characters.

### -param Callback [in]

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,7 @@ The <i>id</i> parameter is a pointer to a <b>GUID</b>.

### -param FoundFile [out]

A pointer to a buffer that receives the fully qualified path to the symbol file. This buffer must be at least MAX_PATH characters.
A pointer to a buffer that receives the fully qualified path to the symbol file. This buffer must be at least MAX_PATH+1 characters.

### -param callback [in, optional]

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,7 @@ The <i>id</i> parameter is a pointer to a <b>GUID</b>.

### -param FoundFile [out]

A pointer to a buffer that receives the fully qualified path to the symbol file. This buffer must be at least MAX_PATH characters.
A pointer to a buffer that receives the fully qualified path to the symbol file. This buffer must be at least MAX_PATH+1 characters.

### -param callback [in, optional]

Expand Down