Important:
This is retired content. This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This content may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist.
A version of this page is also available for
4/8/2010

This function parses URLs. This is a helper API.

Syntax 

STDAPI CoInternetParseUrl(
  LPCWSTR 
pwzUrl,
  PARSEACTION 
ParseAction,
  DWORD 
dwFlags,
  LPWSTR 
pszResult,
  DWORD 
cchResult,
  DWORD* 
pcchResult,
  DWORD 
dwReserved
);

Parameters

pwzUrl

String value that contains the URL to parse.

ParseAction

ParseActionvalue that determines the information to be parsed from the URL.

dwFlags

Unsigned long integer value that controls the parsing operation, based on the value passed as the ParseActionparameter.

pszResult

String value that contains the information parsed from the URL.

cchResult

Unsigned long integer value that contains the size of the buffer.

pcchResult

Address of an unsigned long integer value that contains the size of the information stored in the buffer.

dwReserved

Reserved. Must be set to zero.

Return Value

Returns one of the values shown in the following table.

Value Description

S_OK

Success.

S_FALSE

The buffer was too small to contain the resulting URL.

INET_E_DEFAULT_ACTION

Use the default action.

Remarks

If PARSE_CANONICALIZE was passed as the ParseActionparameter, the flags valid for the dwFlagsparameter of UrlCanonicalizecan be passed to the dwFlagsparameter of CoInternetParseUrlto control the parsing operation.

If PARSE_UNESCAPE or PARSE_ENCODE was passed as the ParseActionparameter, the flags valid for the dwFlagsparameter of UrlUnescapecan be passed to the dwFlagsparameter of CoInternetParseUrlto control the parsing operation.

If PARSE_ESCAPE or PARSE_DECODE was passed as the ParseActionparameter, the flags valid for the dwFlagsparameter of UrlEscapecan be passed to the dwFlagsparameter of CoInternetParseUrlto control the parsing operation.

If PARSE_PATH_FROM_URL was passed as the ParseActionparameter, the flags valid for the dwFlagsparameter of PathCreateFromUrlcan be passed to the dwFlagsparameter of CoInternetParseUrlto control the parsing operation.

If PARSE_URL_FROM_PATH was passed as the ParseActionparameter, the flags valid for the dwFlagsparameter of UrlCreateFromPathcan be passed to the dwFlagsparameter of CoInternetParseUrlto control the parsing operation.

Requirements

Header urlmon.h, urlmon.idl
Library urlmon.lib
Windows Embedded CE Windows CE .NET 4.0 and later
Windows Mobile Windows Mobile Version 5.0 and later