HlinkGetSpecialReference function

[HlinkGetSpecialReference may be altered or unavailable in subsequent versions of the operating system or product.]

Note The Microsoft ActiveX Hyperlink API is deprecated in Windows Internet Explorer 8 and later, and ActiveX technology as a whole is unsupported in the Microsoft Edge browser in favor of standards-based web APIs. For more information, see Saying goodbye to ActiveX, VBScript, attachEvent... and Get ready for plug-in free browsing.

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

Syntax


HRESULT HlinkGetSpecialReference(
  _In_  unsigned long uReference,
  _Out_ LPWSTR        *ppwzReference
);

uReference [in]: The value taken from the HLSR enumeration.
ppwzReference [out]: An indirect pointer to the location to return the special reference string. This must not be NULL.

Returns S_OK if successful, or an error value otherwise.

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