Skip to content

Latest commit

 

History

History
142 lines (87 loc) · 3.31 KB

nf-shlwapi-urlisa.md

File metadata and controls

142 lines (87 loc) · 3.31 KB
Raw
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NF:shlwapi.UrlIsA
UrlIsA function (shlwapi.h)
Tests whether a URL is a specified type. (ANSI)
UrlIsA
shlwapi/UrlIsA
shell\UrlIs.htm
shell
2e83c953-b4c5-4411-90ca-49ffb94ee374
12/05/2018
URLIS_APPLIABLE, URLIS_DIRECTORY, URLIS_FILEURL, URLIS_HASQUERY, URLIS_NOHISTORY, URLIS_OPAQUE, URLIS_URL, UrlIs, UrlIs function [Windows Shell], UrlIsA, UrlIsW, _win32_UrlIs, shell.UrlIs, shlwapi/UrlIs, shlwapi/UrlIsA, shlwapi/UrlIsW
shlwapi.h
Windows
Windows 2000 Professional, Windows XP [desktop apps only]
Windows 2000 Server [desktop apps only]
UrlIsW (Unicode) and UrlIsA (ANSI)
Shlwapi.lib
Shlwapi.dll (version 5.0 or later)
Windows
19H1
UrlIsA
shlwapi/UrlIsA
c++
APIRef
kbSyntax
DllExport
Shlwapi.dll
API-MS-Win-Core-url-l1-1-0.dll
KernelBase.dll
API-MS-Win-DownLevel-shlwapi-l1-1-0.dll
API-MS-Win-DownLevel-shlwapi-l1-1-1.dll
UrlIs
UrlIsA
UrlIsW

UrlIsA function

-description

Tests whether a URL is a specified type.

-parameters

-param pszUrl [in]

Type: PCTSTR

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

-param UrlIs

Type: URLIS

The type of URL to be tested for. This parameter can take one of the following values.

URLIS_APPLIABLE

Attempt to determine a valid scheme for the URL.

URLIS_DIRECTORY

Does the URL string end with a directory?

URLIS_FILEURL

Is the URL a file URL?

URLIS_HASQUERY

Does the URL have an appended query string?

URLIS_NOHISTORY

Is the URL a URL that is not typically tracked in navigation history?

URLIS_OPAQUE

Is the URL opaque?

URLIS_URL

Is the URL valid?

-returns

Type: BOOL

For all but one of the URL types, UrlIs returns TRUE if the URL is the specified type, or FALSE if not.

If UrlIs is set to URLIS_APPLIABLE, UrlIs will attempt to determine the URL scheme. If the function is able to determine a scheme, it returns TRUE, or FALSE otherwise.

-see-also

UrlIsFileUrl

UrlIsNoHistory

UrlIsOpaque

-remarks

Note

The shlwapi.h header defines UrlIs 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.