goring Command

Move to or create a new ring in an Editor window.

Scope: Global

Syntax

Parameter

next 
Move to the next ring.
prev 
Move to the previous ring.
next split 
Move to the next split file view within an Editor window.
Note: This parameter is valid only when issued in an Editor window.
prev split 
Move to the previous split file view within an Editor window.
Note: This parameter is valid only when issued in an Editor window.
new 
Create a new ring with the current file view within an Editor window.
Note: This parameter is valid only when issued in an Editor window.
split 
Create a new ring with the current file view. An Editor window is split to contain the new ring.
Note: This parameter is valid only when issued in an Editor window.
ringnum Number 
Move to the ring number specified by Number. Number must be a positive integer value greater than 0.

Description

Use the goring command to move to or create new rings in the current editing session.

Specifying the goring command without parameters moves you to the previous ring.

Specifying the new parameter has no effect on a file view that is already the only member of its ring.

Examples

  1. To move the current file view into a new ring, type:
    goring new 
  2. To move to ring number 6, assuming it exists, type:
    goring ringnum 6 

API Return Codes

-1 
Invalid command parameter given. Issue the command again using a valid parameter.
-2 
Invalid ring number given. Issue the command again using a ring number value in the valid range.
1 
The ring number specified does not exist.
3 
You are already in the ring specified.
4 
The file view is already the only member of the ring.
5 
You specified a next split or prev split parameter, but no other split file view exists to move to.