Edit

UrlIsFileUrlA macro (shlwapi.h)

  • Article

Tests a URL to determine if it is a file URL.

Syntax

void UrlIsFileUrlA(
   pszURL
);

Parameters

pszURL

Type: LPCTSTR

A pointer to a null-terminated string containing the URL.

Return value

None

Remarks

A file URL has the form "File:// xxx". UrlIsFileUrl is actually one of the following macros, depending on whether ANSI or Unicode is selected.


#define  UrlIsFileUrlA(pszURL) UrlIsA(pszURL, URLIS_FILEURL)
#define  UrlIsFileUrlW(pszURL) UrlIsW(pszURL, URLIS_FILEURL)

Note

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

See also

UrlIs