markinclude Parameter

Gives the include setting of a mark.

Scope: View

Syntax

query markinclude.[Name|#Id ] 

Options

Name 
The name of a named mark to query.
Id 
The id number of an unnamed mark to query.

Description

If the specified mark is included, the markinclude parameter will return a value of on. Otherwise, it returns a value of off.

A mark can be specified by its name if it is a named mark, or by its id number. If Name or Id is not specified, the last mark created is queried.

Example

  1. To get the include setting of the named mark mark1, type:
    query markinclude.mark1
  2. To get the include setting of the unnamed mark with id number 765, type:
    query markinclude.#765
  3. To get the include setting of the mark most recently created, type:
    query markinclude.

API Return Codes

None.


mark Command
markexclude Parameter