InternetCanonicalizeUrl.md

Home

Function name : InternetCanonicalizeUrl

Group: Internet Functions (WinInet) - Library: wininet

---

Canonicalizes a URL, which includes converting unsafe characters and spaces into escape sequences.

---

Code examples:

URL: converting unsafe characters and spaces into escape sequences

Declaration:

BOOL InternetCanonicalizeUrl(
	LPCTSTR lpszUrl,
	LPTSTR lpszBuffer,
	LPDWORD lpdwBufferLength,
	DWORD dwFlags
);  

---

FoxPro declaration:

DECLARE INTEGER InternetCanonicalizeUrl IN wininet;
	STRING    lpszUrl,;
	STRING  @ lpszBuffer,;
	INTEGER @ lpdwBufferLength,;
	INTEGER   dwFlags  

---

Parameters:

lpszUrl [in] Pointer to the string that contains the URL to canonicalize.

lpszBuffer [out] Pointer to the buffer that receives the resulting canonicalized URL.

lpdwBufferLength [in, out] Pointer to an unsigned long integer value that contains the length, in bytes, of the lpszBuffer buffer.

dwFlags [in] Unsigned long integer value that contains the flags that control canonicalization.

---

Return value:

Returns TRUE if successful, or FALSE otherwise.

---

Comments:

If no flags are specified (dwFlags = 0), the function converts all unsafe characters and meta sequences (such as .,\ .., and ...) to escape sequences.

See UrlEscape and UrlUnescape functions.

---