HlinkGetSpecialReference Function

---

Retrieves a string for a given value from the HLSR enumeration.

Syntax

HRESULT HlinkGetSpecialReference(
    ULONG uReference,    
    LPWSTR *ppwzReference    
);

Parameters

uReference

[in] Value taken from the HLSR enumeration.

ppwzReference

[out] Indirect pointer to the location to return the special reference string. This must not be NULL.

Return Value

Returns S_OK if successful, or an error code otherwise.

Remarks

The string returned by this function will contain the current user's default home, search, or history page.

Function Information

Windows NT	Use version 4.0.
Windows	Use Windows 95 and later.
Header	Hlink.h
Import Library	Hlink.lib
Minimum availability	Internet Explorer 3.0

See Also

HlinkSetSpecialReference