Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

AtlCanonicalizeUrl

 

Call this function to canonicalize a URL, which includes converting unsafe characters and spaces into escape sequences.


      inline BOOL AtlCanonicalizeUrl(
   LPCTSTR szUrl,
   LPTSTR szCanonicalized,
   DWORD* pdwMaxLength,
   DWORD dwFlags = 0 
) throw( );

szUrl

The URL to be canonicalized.

szCanonicalized

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.

dwFlags

Flags controlling the behavior of this function. See ATL_URL Flags.

Returns TRUE on success, FALSE on failure.

Behaves like the current version of InternetCanonicalizeUrl but does not require WinInet or Internet Explorer to be installed.

Requirements

Header: atlutil.h

Show: