UrlIsOpaqueW function (shlwapi.h)

Article
02/22/2024

Returns whether a URL is opaque.

Syntax

BOOL UrlIsOpaqueW(
  [in] PCWSTR pszURL
);

Parameters

[in] pszURL

Type: PCTSTR

A null-terminated string of maximum length INTERNET_MAX_URL_LENGTH that contains the URL.

Return value

Type: BOOL

Returns a nonzero value if the URL is opaque, or zero otherwise.

Remarks

A URL that has a scheme that is not followed by two slashes (//) is opaque. For example, xyz@litwareinc.com is an opaque URL. Opaque URLs cannot be separated into the standard URL hierarchy. UrlIsOpaque is equivalent to the following:

UrlIs(pszURL, URLIS_OPAQUE)

Note

The shlwapi.h header defines UrlIsOpaque as an alias which automatically selects the ANSI or Unicode version of this function based on the definition of the UNICODE preprocessor constant. Mixing usage of the encoding-neutral alias with code that not encoding-neutral can lead to mismatches that result in compilation or runtime errors. For more information, see Conventions for Function Prototypes.

Requirements

Requirement	Value
Minimum supported client	Windows 2000 Professional, Windows XP [desktop apps only]
Minimum supported server	Windows 2000 Server [desktop apps only]
Target Platform	Windows
Header	shlwapi.h
Library	Shlwapi.lib
DLL	Shlwapi.dll (version 5.0 or later)