Reference

UrlCanonicalizeA(3w)

NAME

UrlCanonicalizeA (SHLWAPI.@)

SYNOPSIS

HRESULT UrlCanonicalizeA
(
LPCSTR pszUrl,
LPSTR pszCanonicalized,
LPDWORD pcchCanonicalized,
DWORD dwFlags
)

DESCRIPTION

Canonicalize a Url.

PARAMS

pszUrl [In] Url to cCanonicalize.

pszCanonicalized [Out] Destination for converted Url.

pcchCanonicalized [In/Out] Length of pszUrl, destination for length of pszCanonicalized.

dwFlags [In] Flags controlling the conversion.

RETURNS

Success: S_OK. The pszCanonicalized contains the converted Url.

Failure: E_POINTER, if *pcchCanonicalized is too small.

MSDN incorrectly describes the flags for this function. They should be:

URL_DONT_ESCAPE_EXTRA_INFO 0x02000000

URL_ESCAPE_SPACES_ONLY 0x04000000

URL_ESCAPE_PERCENT 0x00001000

URL_ESCAPE_UNSAFE 0x10000000

URL_UNESCAPE 0x10000000

URL_DONT_SIMPLIFY 0x08000000

URL_ESCAPE_SEGMENT_ONLY 0x00002000

IMPLEMENTATION

Declared in "shlwapi.h".

Implemented in "dlls/shlwapi/url.c".

Debug channel "shell".

History