Skip to content

Fix atl http utility functions documetnation #61

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Aug 17, 2017
Merged

Fix atl http utility functions documetnation #61

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
18553db
Fix atl http utility functions documetnation
will-bartlett Aug 17, 2017
6be82d9
Missed AtlUnescapeUrl
will-bartlett Aug 17, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions docs/atl/reference/atl-http-utility-functions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ inline BOOL AtlCanonicalizeUrl(
Caller-allocated buffer to receive the canonicalized URL.

`pdwMaxLength`
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.
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.

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

`pdwMaxLength`
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.
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.

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

`pdwStrLen`
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.
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.

`dwMaxLength`
The size of the buffer `lpszStringOut`.
Expand Down Expand Up @@ -198,7 +198,7 @@ inline BOOL AtlUnescapeUrl(
Caller-allocated buffer to which the converted URL will be written.

`pdwStrLen`
Pointer to a DWORD variable. 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.
Pointer to a DWORD variable. 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.

`dwMaxLength`
The size of the buffer `lpszStringOut`.
Expand Down