InternetCreateUrl Function

Creates a URL from its component parts.

Syntax

BOOL InternetCreateUrl%( 
    IN LPURL_COMPONENTS% lpUrlComponents,
    IN DWORD dwFlags,
    OUT LPTSTR% lpszUrl,
    IN OUT LPDWORD lpdwUrlLength
);

The actual syntax of this function varies between its ANSI and Unicode implementations. See the Win32 Internet Functions Syntax document for details.

Parameters

lpUrlComponents

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

dwFlags

Unsigned long integer value that contains the flags that control the operation of this function. Can be a combination of these values:

ICU_ESCAPE	Converts all escape sequences (%xx) to their corresponding characters.
ICU_USERNAME	When adding the user name, uses the name that was specified at logon time.

lpszUrl

Address of a buffer that receives the URL.

lpdwUrlLength

Address of an unsigned long integer value that contains the length, in bytes, of the lpszUrl buffer. When the function returns, this parameter receives the length, in characters, of the URL string, minus 1 for the terminating character. 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.

Function Information

Windows NT	Use version 4.0 and later. Implemented as ANSI and Unicode functions.
Windows	Use Windows 95 and later. Implemented as ANSI and Unicode functions.
Header	Wininet.h
Import library	Wininet.lib
Minimum availability	Internet Explorer 3.0 (ANSI only), 5 (ANSI and Unicode)

See Also

Microsoft Win32 Internet Functions Overview, Handling Uniform Resource Locators, Microsoft Win32 Internet Functions Reference, Uniform Resource Locator (URL) Functions

Does this content meet your programming needs? Write us!

Back to top