loadCSH()

Submitted by Willam van Weelden on

Function that loads the current project's CSH into the global variables CSH, MapNumbers and TopicIds. This function is called by getNextMapNumber() and .CSH() when the project's CSH is not yet loaded.

The function loadCSH() is located in the file csh.jsxinc.

Usage

loadCSH();

Paramters

This function has no parameters.

Return values

This function has no return values.

Structure of global variables

The global variables CSH, MapNumbers and TopicIds are initialized by this function. This paragraph describes the structure of the global variables.

CSH

The global variable CSH is false when the CSH is not yet initialized. Otherwise the global variable is an array with the following structure:

- Numeric array key
|- CSHTopicidKey
|- CSHMapnumberKey
|- CSHTopicKey

Each key in the array is an embedded array. You use global variables to get the desired key:

  • Use the global variable CSHTopicidKey for the TopicId.
  • Use the global variable CSHMapnumberKey for the map number.
  • Use the global variable CSHTopicKey for the topic path (relative from project root).

The keys CSHTopicidKey and CSHMapnumberKey always have a value. When no topic is linked to these CSH keys, the array key CSHTopicKey is false.

MapNumbers

The global variable MapNumbers is false when the CSH is not yet initialized. Otherwise the global variable is a single level array with all the map numbers used in the project.

TopicIds

The global variable TopicIds is false when the CSH is not yet initialized. Otherwise the global variable is a single level array with all the TopicId's used in the project.