HLID enumeration

  • Article

[HLID 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.

 

Identifies the logical positions of a hyperlink identifier in the hyperlink navigation stack. The constants are used in the IHlinkBrowseContext interface.

Syntax

typedef enum  { 
  HLID_PREVIOUS     = 0xFFFFFFFF,
  HLID_NEXT         = 0xFFFFFFFE,
  HLID_CURRENT      = 0xFFFFFFFD,
  HLID_STACKBOTTOM  = 0xFFFFFFFC,
  HLID_STACKTOP     = 0xFFFFFFFB
} HLID;

Constants

  • HLID_PREVIOUS
    Hyperlink prior to the current one. If the current hyperlink is the first or only hyperlink in the navigation stack, or if there are no hyperlinks in the navigation stack, there is no previous hyperlink, and methods such as IHlinkBrowseContext::GetHlink will return NULL and E_FAIL when passed this value.

  • HLID_NEXT
    Hyperlink after the current one. If the current hyperlink is the last or only hyperlink in the navigation stack, or if there are no hyperlinks in the navigation stack, there is no next hyperlink, and methods such as IHlinkBrowseContext::GetHlink will return NULL and E_FAIL when passed this value.

  • HLID_CURRENT
    Current hyperlink. A browsing tool might offer a command to reload the current page, or to recenter the user interface around the beginning portion of the current hyperlink destination, or to restart animation, sound, or other activity by renavigating to the current hyperlink.

  • HLID_STACKBOTTOM
    First hyperlink in the navigation stack. If there are no hyperlinks in the navigation stack, there is no stack-bottom hyperlink, and methods such as IHlinkBrowseContext::GetHlink will return NULL and E_FAIL when passed this value.

  • HLID_STACKTOP
    Last hyperlink in the navigation stack. If there are no hyperlinks in the navigation stack, there is no stack-top hyperlink, and methods such as IHlinkBrowseContext::GetHlink will return NULL and E_FAIL when passed this value.

Remarks

For convenience and performance, individual hyperlink objects are often identified in a navigation stack like a browse context or a history/favorites list using a unsigned long hyperlink identifier or HLID rather than an IHlink interface pointer. This prevents unnecessary passing of interface pointers across process boundaries in common user-interface scenarios, such as building a drop-down menu or scrollable list of the history, or when testing the current location in the navigation stack to go back and forward.

Requirements

Minimum supported client

Windows XP

Minimum supported server

Windows 2000 Server

Header

 Hlink.h

See also

Reference

HLQF

IHlinkBrowseContext::GetHlink

IHlinkBrowseContext::QueryHlink

IHlinkBrowseContext::SetCurrentHlink