IHlink  Interface

IID_IHLink

{79EAC9C3-BAF9-11CE-8C82-00AA004BA90B}

This interface provides methods that enable a hyperlink to navigate to its target, access a display name for display purposes, and identify itself to its container and frame.
 

Methods in VTable order

IUnknown Methods

Description

QueryInterface

Returns pointers to supported interfaces.

AddRef

Increments reference count.

Release

Decrements reference count.

IHlink Methods

Description

SetHlinkSite

Saves the interface pointer on the site object.

GetHlinkSite

Retrieves the interface pointer on the site object.

SetMonikerReference

Sets the moniker reference of the target.

GetMonikerReference

Retrieves the moniker and location portions of the target.

SetStringReference

Sets the name and location portions of the target.

GetStringReference

Retrieves the name and location portions of the target.

SetFriendlyName

Sets the display name of the target.

GetFriendlyName

Retrieves the display name of the target.

SetTargetFrameName

Sets the name of the target frame.

GetTargetFrameName

Retrieves the name of the target frame.

GetMiscStatus

Retrieves a value that indicates whether the hyperlink is absolute or relative.

Navigate

Navigates to the specified target.

SetAdditionalParams

Not currently implemented.

GetAdditionalParams

Not currently implemented.

SetHlinkSite

FUNCTION IHlink_SetHlinkSite ( _
  BYVAL pthis AS DWORD PTR _
, BYVAL pihlSite AS DWORD _
, BYVAL dwSiteData AS DWORD _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pthis[3] USING IHlink_SetHlinkSite (pthis, pihlSite, dwSiteData) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION
 

GetHlinkSite

FUNCTION IHlink_GetHlinkSite ( _
  BYVAL pthis AS DWORD PTR _
, BYREF ppihlSite AS DWORD _
, BYREF pdwSiteData AS DWORD _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pthis[4] USING IHlink_GetHlinkSite (pthis, ppihlSite, pdwSiteData) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION

SetMonikerReference

FUNCTION IHlink_SetMonikerReference ( _
  BYVAL pthis AS DWORD PTR _
, BYVAL grfHLSETF AS DWORD _
, BYVAL pimkTarget AS DWORD _
, BYVAL strLocation AS STRING _
  ) AS LONG

  LOCAL HRESULT AS LONG

  strLocation = UCODE$(strLocation) & $NUL

  CALL DWORD @@pthis[5] USING IHlink_SetMonikerReference (pthis, grfHLSETF, pimkTarget, strLocation) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION
 

GetMonikerReference

FUNCTION Proto_IHlink_GetMonikerReference ( _
  BYVAL pthis AS DWORD PTR _
, BYVAL dwWhichRef AS DWORD _
, BYREF ppimkTarget AS DWORD _
, BYREF ppwzLocation AS DWORD _
  ) AS LONG
 

FUNCTION IHlink_GetMonikerReference ( _
  BYVAL pthis AS DWORD PTR _
, BYVAL dwWhichRef AS DWORD _
, BYREF ppimkTarget AS DWORD _
, BYREF strLocation AS STRING _
  ) AS LONG

  strLocation = ""

  LOCAL HRESULT AS LONG

  LOCAL bstrlen AS LONG

  LOCAL ppwzLocation AS DWORD

  CALL DWORD @@pthis[6] USING Proto_IHlink_GetMonikerReference (pthis, dwWhichRef, ppimkTarget, ppwzLocation) TO HRESULT
  IF ISTRUE ppwzLocation THEN
     bstrlen = lstrlenW(BYVAL ppwzLocation)
     IF ISTRUE bstrlen THEN
        strLocation = PEEK$(ppwzLocation, bstrlen * 2)
        strLocation = ACODE$(strLocation)
     END IF
     CoTaskMemFree ppwzLocation
  END IF
  FUNCTION = HRESULT

END FUNCTION
 

SetStringReference

FUNCTION IHlink_SetStringReference ( _
  BYVAL pthis AS DWORD PTR _
, BYVAL grfHLSETF AS DWORD _
, BYVAL strTarget AS STRING _
, BYVAL strLocation AS STRING _
  ) AS LONG

  LOCAL HRESULT AS LONG
  strTarget = UCODE$(strtarget) & $NUL

  strLocation = UCODE$(strLocation) & $NUL

  CALL DWORD @@pthis[7] USING IHlink_SetStringReference (pthis, grfHLSETF, strTarget, strLocation) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION
 

GetStringReference

FUNCTION Proto_IHlink_GetStringReference ( _
  BYVAL pthis AS DWORD PTR _
, BYVAL dwWhichRef AS DWORD _
, BYREF ppwzTarget AS DWORD _
, BYREF ppwzLocation AS DWORD _
  ) AS LONG
 

FUNCTION IHlink_GetStringReference ( _
  BYVAL pthis AS DWORD PTR _
, BYVAL dwWhichRef AS DWORD _
, BYREF strTarget AS STRING _
, BYREF strLocation AS STRING _
  ) AS LONG
 

  strTarhet = ""

  strLocation = ""
  LOCAL HRESULT AS LONG

  LOCAL bstrlen AS LONG
  LOCAL ppwzTarget AS DWORD
  LOCAL ppwzLocation AS DWORD
  CALL DWORD @@pthis[8] USING Proto_IHlink_GetStringReference (pthis, dwWhichRef, ppwzTarget, ppwzLocation) TO HRESULT
  IF ISTRUE ppwzTarget THEN
     bstrlen = lstrlenW(BYVAL ppwzTarget)
     IF ISTRUE bstrlen THEN
        strTarget = PEEK$(ppwzTarget, bstrlen * 2)
        strTarget = ACODE$(strTarget )
     END IF
     CoTaskMemFree ppwzTarget
  END IF
  IF ISTRUE ppwzLocation THEN
     bstrlen = lstrlenW(BYVAL ppwzLocation)
     IF ISTRUE bstrlen THEN
        strLocation = PEEK$(ppwzLocation, bstrlen * 2)
        strLocation = ACODE$(strLocation)
     END IF
     CoTaskMemFree ppwzLocation
  END IF
  FUNCTION = HRESULT

END FUNCTION
 

SetFriendlyName

FUNCTION IHlink_SetFriendlyName ( _
  BYVAL pthis AS DWORD PTR _
, BYVAL strFriendlyName AS STRING _
  ) AS LONG

  LOCAL HRESULT AS LONG

  strFriendlyName = UCODE$(strFriendlyName) & $NUL
  CALL DWORD @@pthis[9] USING IHlink_SetFriendlyName (pthis, strFriendlyName) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION
 

GetFriendlyName

FUNCTION Proto_IHlink_GetFriendlyName ( _
  BYVAL pthis AS DWORD PTR _
, BYVAL grfHLFNAMEF AS DWORD _
, BYREF ppwzFriendlyName AS DWORD _
  ) AS LONG
 

FUNCTION IHlink_GetFriendlyName ( _
  BYVAL pthis AS DWORD PTR _
, BYVAL grfHLFNAMEF AS DWORD _
, BYREF strFriendlyName AS STRING _
  ) AS LONG
 

  strFriendlyName = ""

  LOCAL HRESULT AS LONG

  LOCAL bstrlen AS LONG

  LOCAL ppwzFriendlyName AS DWORD

  CALL DWORD @@pthis[10] USING Proto_IHlink_GetFriendlyName (pthis, dwFlags) TO HRESULT
  IF ISTRUE ppwzFriendlyName THEN
     bstrlen = lstrlenW(BYVAL ppwzFriendlyName)
     IF ISTRUE bstrlen THEN
        strFriendlyName = PEEK$(ppwzFriendlyName, bstrlen * 2)
        strFriendlyName = ACODE$(strFriendlyName)
     END IF
     CoTaskMemFree ppwzFriendlyName
  END IF
  FUNCTION = HRESULT

END FUNCTION
 

SetTargetFrameName

FUNCTION IHlink_SetTargetFrameName ( _
  BYVAL pthis AS DWORD PTR _
, BYVAL strTargetFrameName AS STRING _

  ) AS LONG

  LOCAL HRESULT AS LONG

  strTargetFrameName = UCODE$(strTargetFrameName) & $NUL
  CALL DWORD @@pthis[11] USING IHlink_SetTargetFrameName (pthis, strTargetFrameName) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION
 

GetTargetFrameName

FUNCTION Proto_IHlink_GetTargetFrameName ( _
  BYVAL pthis AS DWORD PTR _
, BYREF ppwzTargetFrameName AS DWORD _
  ) AS LONG
 

FUNCTION IHlink_GetTargetFrameName ( _
  BYVAL pthis AS DWORD PTR _
, BYREF strTargetFrameName AS STRING _
) AS LONG
 

  strTargetFrameName = ""

  LOCAL HRESULT AS LONG

  LOCAL bstrlen AS LONG

  LOCAL ppwzTargetFrameName AS DWORD

  CALL DWORD @@pthis[12] USING Proto_IHlink_GetTargetFrameName (pthis, ppwzTargetFrameName) TO HRESULT
  IF ISTRUE ppwzTargetFrameName THEN
     bstrlen = lstrlenW(BYVAL ppwzTargetFrameName)
     IF ISTRUE bstrlen THEN
        strTargetFrameName = PEEK$(ppwzTargetFrameName, bstrlen * 2)
        strTargetFrameName = ACODE$(strTargetFrameName)
     END IF
     CoTaskMemFree ppwzTargetFrameName
  END IF
  FUNCTION = HRESULT

END FUNCTION
 

GetMiscStatus

FUNCTION IHlink_GetMiscStatus ( _
  BYVAL pthis AS DWORD PTR _
, BYREF pdwStatus AS DWORD _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pthis[13] USING IHlink_GetMiscStatus (pthis, pdwStatus) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION
 

Navigate

FUNCTION IHlink_Navigate ( _
  BYVAL pthis AS DWORD PTR _
, BYVAL grfHLNF AS DWORD _
, BYVAL pibc AS DWORD _
, BYVAL pibsc AS DWORD _
, BYVAL pihlbc AS DWORD _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pthis[14] USING IHlink_Navigate (pthis, grfHLNF, pibc, pibsc, pihlbc) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION
 

SetAdditionalParams

FUNCTION IHlink_SetAdditionalParams ( _
  BYVAL pthis AS DWORD PTR _
, BYVAL pwzAdditionalParams AS DWORD _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pthis[15] USING IHlink_SetAdditionalParams (pthis, pwzAdditionalParams) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION
 

GetAdditionalParams

FUNCTION IHlink_GetAdditionalParams ( _
  BYVAL pthis AS DWORD PTR _
, BYREF ppwzAdditionalParams AS DWORD _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pthis[16] USING IHlink_GetAdditionalParams (pthis, ppwzAdditionalParams) TO HRESULT
  ppwzAdditionalParams = ACODE$(ppwzAdditionalParams)
  FUNCTION = HRESULT

END FUNCTION