HotlinkInfo() function - MapBasic - 2023

MapInfo MapBasic Reference

Product type
Software
Portfolio
Locate
Product family
MapInfo
Product
MapInfo > MapBasic
Version
2023
Language
English
Product name
MapBasic
Title
MapInfo MapBasic Reference
First publish date
1985
Last updated
2023-09-12
Published on
2023-09-12T16:32:32.686312

Purpose

Returns information about a HotLink definition in a map layer. You can call this function from the MapBasic window in MapInfo Pro.

Syntax

HotlinkInfo ( map_window_id, layer_number, hotlink_number, attribute )

map_window_id is a Map window identifier.

layer_number is the number of a layer in the current Map window (for example, 1 for the top layer); to determine the number of layers in a Map window, call the MapperInfo() function.

hotlink_number - the index of the hotlink definition being queried. The first hotlink definition in a layer has index of 1.

attribute - the following attribute values are allowed:

Hotlink Name ID Description
HOTLINK_INFO_EXPR 1 Returns the filename expression for this hotlink definition.
HOTLINK_INFO_MODE 2 Returns the mode for this hotlink definition, one of the following predefined values:
  • HOTLINK_MODE_LABEL (0)
  • HOTLINK_MODE_OBJ (1)
  • HOTLINK_MODE_BOTH (2)
HOTLINK_INFO_RELATIVE 3 Returns TRUE if the relative path option is on for this hotlink definition.
HOTLINK_INFO_ENABLED 4 Returns TRUE if this hotlink definition is enabled.
HOTLINK_INFO_ALIAS 5 Returns TRUE if this hotlink definition is an alias.

See Also:

Set Map statement, LayerInfo() function