BARfly Help - BAR Interfacial Function Reference - BAR node navigation functions

  BAR::Next

Purpose: To navigate forward to sibling nodes.

bool Next(long Count);


Parameters

long Count: Number of nodes to advance.

Return Values

  • True: Successful navigation.
  • False: Unsuccessful navigation.

Remarks

This function advances the current node to the next logical node in the sequence. The normal behavior is to advance past the current node to the next sibling. The value of Count controls the number of nodes to advance.

However, if this was the last node at a particular hierarchy level, the focus will instead move back up the hierarchy and advance to the next node from the parent. The process will repeat itself all the way to the top-level node if the parent was also the last node at its own hierarchy level.

This function fails if no file was loaded or if there is no next logical node in the sequence at any hierarchy level. In the event of failure, the current node shall not change.

Compatibility

  All Platforms Win32 C++ LIB
BAR version 1.1 1.1
  All Platforms Win32
BARfly version 1.0 1.0


  See also:  [BAR type lookup functions] [BAR loading and saving functions] [BAR node navigation functions]
[BAR node information functions] [BAR data reading functions] [BAR data writing functions] [BAR miscellaneous functions]


BARfly Help Copyright © 2009 Christopher Allen