UrlHashW function (shlwapi.h)
Hashes a URL string.
Syntax
LWSTDAPI UrlHashW(
[in] PCWSTR pszUrl,
[out] BYTE *pbHash,
DWORD cbHash
);
Parameters
[in] pszUrl
Type: PCTSTR
A null-terminated string of maximum length INTERNET_MAX_URL_LENGTH that contains the URL.
[out] pbHash
Type: BYTE*
A pointer to a buffer that, when this function returns successfully, receives the hashed array.
cbHash
Type: DWORD
The number of elements in the array at pbHash. It should be no larger than 256.
Return value
Type: HRESULT
If this function succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.
Remarks
To hash a URL into a single byte, set cbHash = sizeof(BYTE) and pbHash = (LPBYTE)&bHashedValue, where bHashedValue is a one-byte buffer. To hash a URL into a DWORD, set cbHash = sizeof(DWORD) and pbHash = (LPBYTE)&dwHashedValue, where dwHashedValue is a DWORD buffer.
Note
The shlwapi.h header defines UrlHash 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) |