Share via


AtlCanonicalizeUrl

 

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

Syntax

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

Parameters

  • 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.

Return Value

Returns TRUE on success, FALSE on failure.

Remarks

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

Requirements

Header: atlutil.h

See Also

Active Template Library (ATL) Concepts
ATL COM Desktop Components
ATL Functions Alphabetical Reference
InternetCanonicalizeUrl