InternetCreateUrl function

Creates a URL from its component parts.

Syntax

BOOL InternetCreateUrl(
  _In_    LPURL_COMPONENTS lpUrlComponents,
  _In_    DWORD            dwFlags,
  _Out_   LPTSTR           lpszUrl,
  _Inout_ LPDWORD          lpdwUrlLength
);

Parameters

lpUrlComponents [in]

Pointer to a URL_COMPONENTS structure that contains the components from which to create the URL.

dwFlags [in]

Controls the operation of this function. This parameter can be one or more of the following values.

Value	Meaning
ICU_ESCAPE	Converts all unsafe characters to their corresponding escape sequences in the path string pointed to by the lpszUrlPath member and in lpszExtraInfo the extra-information string pointed to by the member of the URL_COMPONENTS structure pointed to by the lpUrlComponents parameter. The Unicode version of InternetCreateUrl will first try to convert using the system code page. If that fails it falls back to UTF-8.
ICU_USERNAME	Obsolete — ignored.

 

lpszUrl [out]

Pointer to a buffer that receives the URL.

lpdwUrlLength [in, out]

Pointer to a variable that specifies the size of the URLlpszUrl buffer, in TCHARs. When the function returns, this parameter receives the size of the URL string, excluding the NULL terminator. If GetLastError returns ERROR_INSUFFICIENT_BUFFER, this parameter receives the number of bytes required to hold the created URL.

Return value

Returns TRUE if the function succeeds, or FALSE otherwise. To get extended error information, call GetLastError.

Remarks

When specifying scheme in the URL_COMPONENTS structure passed to lpUrlComponents, if lpszScheme is not NULL it will be used for the scheme. If lpszScheme is NULL, the scheme can be specified using the INTERNET_SCHEME enumeration by setting nScheme to the required INTERNET_SCHEME or INTERNET_SCHEME_DEFAULT.

Requirements

See also

Handling Uniform Resource Locators

WinINet Functions