Skip to content

Commit 18553db

Browse files
Fix atl http utility functions documetnation
The implementation returns pdwMaxLength including the terminating null character in all cases.
1 parent a3b0eb6 commit 18553db

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

docs/atl/reference/atl-http-utility-functions.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ inline BOOL AtlCanonicalizeUrl(
4848
Caller-allocated buffer to receive the canonicalized URL.
4949

5050
`pdwMaxLength`
51-
Pointer to a variable that contains the length in characters of `szCanonicalized`. If the function succeeds, the variable receives the number of characters written to the buffer not including the terminating null character. If the function fails, the variable receives the required length in bytes of the buffer including space for the terminating null character.
51+
Pointer to a variable that contains the length in characters of `szCanonicalized`. If the function succeeds, the variable receives the number of characters written to the buffer including the terminating null character. If the function fails, the variable receives the required length in bytes of the buffer including space for the terminating null character.
5252

5353
`dwFlags`
5454
ATL_URL flags controlling the behavior of this function.
@@ -93,7 +93,7 @@ inline BOOL AtlCombineUrl(
9393
Caller-allocated buffer to receive the canonicalized URL.
9494

9595
`pdwMaxLength`
96-
Pointer to a variable that contains the length in characters of `szBuffer`. If the function succeeds, the variable receives the number of characters written to the buffer not including the terminating null character. If the function fails, the variable receives the required length in bytes of the buffer including space for the terminating null character.
96+
Pointer to a variable that contains the length in characters of `szBuffer`. If the function succeeds, the variable receives the number of characters written to the buffer including the terminating null character. If the function fails, the variable receives the required length in bytes of the buffer including space for the terminating null character.
9797

9898
`dwFlags`
9999
Flags controlling the behavior of this function. See [AtlCanonicalizeUrl](#atlcanonicalizeurl).
@@ -131,7 +131,7 @@ inline BOOL AtlEscapeUrl(
131131
Caller-allocated buffer to which the converted URL will be written.
132132

133133
`pdwStrLen`
134-
Pointer to a DWORD variable. If the function succeeds, `pdwStrLen` receives the number of characters written to the buffer, not including the terminating null character. If the function fails, the variable receives the required length in bytes of the buffer including space for the terminating null character. When using the wide character version of this method, `pdwStrLen` receives the number of characters required, not the number of bytes.
134+
Pointer to a DWORD variable. If the function succeeds, `pdwStrLen` receives the number of characters written to the buffer including the terminating null character. If the function fails, the variable receives the required length in bytes of the buffer including space for the terminating null character. When using the wide character version of this method, `pdwStrLen` receives the number of characters required, not the number of bytes.
135135

136136
`dwMaxLength`
137137
The size of the buffer `lpszStringOut`.

0 commit comments

Comments
 (0)