Paper and Page Management

Functions
Boolean_t	TecUtilPageCreateNew (void)
	Creates a new page.
void	TecUtilPageSetCurrentToNext (void)
	Changes the current page to the next one in the internal linked list of pages.
void	TecUtilPageSetCurrentToPrev (void)
	Changes the current page to the previous one in the internal linked list of pages.
Boolean_t	TecUtilPageSetCurrentByName (const char *PageName)
	Sets the current page to one matching the passed name.
Boolean_t	TecUtilPageSetCurrentByUniqueID (UniqueID_t UniqueID)
	Sets the current page to one matching the passed unique ID.
void	TecUtilPageDelete (void)
	Deletes the current page.
void	TecUtilPageClear (void)
	Deletes all frames in the current page.
void	TecUtilPaperGetDimensions (double *Width, double *Height)
	Get the dimensions of the currently defined paper in the Tecplot workspace.
LgIndex_t	TecUtilPageGetCount (void)
	Returns the number of pages managed by Tecplot.
Boolean_t	TecUtilPageGetName (char **PageName)
	Get the name of the current page.
UniqueID_t	TecUtilPageGetUniqueID (void)
	Gets the unique ID for the current page.
SetValueReturnCode_e	TecUtilPageSetName (const char *Name)
	Set the name for the current page.

---

Function Documentation

void TecUtilPageClear

(

void

)

Deletes all frames in the current page.

Fortran Syntax:

    INTEGER*4 FUNCTION TecUtilPageClear()

Python Syntax:

  Results = TecUtil.PageClear()

  Output:
    Results[0]    ReturnVal            NONE

Since:

11.0-5-014

Boolean_t TecUtilPageCreateNew

(

void

)

Creates a new page.

Returns:

TRUE is pages created successfully. Fortran Syntax:

    INTEGER*4 FUNCTION TecUtilPageCreateNew()

Python Syntax:

  Results = TecUtil.PageCreateNew()

  Output:
    Results[0]    ReturnVal            boolean

Since:

11.0-5-014

void TecUtilPageDelete

(

void

)

Deletes the current page.

Will set the next page from the internal linked list to be current.

Fortran Syntax:

    INTEGER*4 FUNCTION TecUtilPageDelete()

Python Syntax:

  Results = TecUtil.PageDelete()

  Output:
    Results[0]    ReturnVal            NONE

Since:

11.0-5-014

LgIndex_t TecUtilPageGetCount

(

void

)

Returns the number of pages managed by Tecplot.

Since:

11.0-5-013

Fortran Syntax:

    INTEGER*4 FUNCTION TecUtilPageGetCount()

Python Syntax:

  Results = TecUtil.PageGetCount()

  Output:
    Results[0]    ReturnVal            int

Returns:

Number of pages managed by Tecplot.

Boolean_t TecUtilPageGetName

(

char **

PageName

)

Get the name of the current page.

Parameters:

PageName

Receives the name of the current page. You must free the returned string with TecUtilStringDealloc().

Returns:

TRUE if successful, FALSE if not.

Fortran Syntax:

    INTEGER*4 FUNCTION TecUtili(
   &                   PageName,
   &                   PageNameLength)
    CHARACTER*(*)   PageName
    INTEGER*4       PageNameLength

Python Syntax:

  Results = TecUtil.PageGetName()

  Output:
    Results[0]    ReturnVal            boolean
    Results[1]    PageName             string

UniqueID_t TecUtilPageGetUniqueID

(

void

)

Gets the unique ID for the current page.

A unique ID is an integer value unique to a page during the Tecplot session. Using the unique ID a page can be compared to other pages and manipulated via TecUtil calls that take unique IDs. This function is Thread Safe.

Fortran Syntax:

    INTEGER*4 FUNCTION TecUtilPageGetUniqueID()

Python Syntax:

  Results = TecUtil.PageGetUniqueID()

  Output:
    Results[0]    ReturnVal            long

Returns:

The unique ID for the current page.

Boolean_t TecUtilPageSetCurrentByName

(

const char *

PageName

)

Sets the current page to one matching the passed name.

Parameters:

PageName

the name of the page to be set as the current.

Returns:

TRUE is a page was found for the passed name.

Fortran Syntax:

    INTEGER*4 FUNCTION TecUtilPageSetCurrentByName(PageName)
    CHARACTER*(*) PageName

Python Syntax:

  Results = TecUtil.PageSetCurrentByName(PageName)

  Input:
                  PageName             string
  Output:
    Results[0]    ReturnVal            boolean

Since:

11.0-5-014

Boolean_t TecUtilPageSetCurrentByUniqueID

(

UniqueID_t

UniqueID

)

Sets the current page to one matching the passed unique ID.

Parameters:

UniqueID

ID of the page to be set as the current.

Returns:

TRUE is a page was found for the passed ID.

Fortran Syntax:

    INTEGER*4 FUNCTION TecUtilPageSetCurrentByUniqueID(UniqueID)
    POINTER         (ValuePtr, UniqueID)

Python Syntax:

  Results = TecUtil.PageSetCurrentByUniqueID(UniqueID)

  Input:
                  UniqueID             long
  Output:
    Results[0]    ReturnVal            boolean

Since:

11.0-5-014

void TecUtilPageSetCurrentToNext

(

void

)

Changes the current page to the next one in the internal linked list of pages.

Fortran Syntax:

    INTEGER*4 FUNCTION TecUtilFrameSetCurrentToNext()

Python Syntax:

  Results = TecUtil.PageSetCurrentToNext()

  Output:
    Results[0]    ReturnVal            NONE

Since:

11.0-5-014

void TecUtilPageSetCurrentToPrev

(

void

)

Changes the current page to the previous one in the internal linked list of pages.

Fortran Syntax:

    INTEGER*4 FUNCTION TecUtilFrameSetCurrentToPrev()

Python Syntax:

  Results = TecUtil.PageSetCurrentToPrev()

  Output:
    Results[0]    ReturnVal            NONE

Since:

11.0-5-014

SetValueReturnCode_e TecUtilPageSetName

(

const char *

Name

)

Set the name for the current page.

Parameters:

Name

Name to assign to the current page.

Returns:

The setvalue return code (of type SetValueReturnCode_e).

Fortran Syntax:

    INTEGER*4 FUNCTION TecUtilPageSetName(Name)
    CHARACTER*(*) Name

Python Syntax:

  Results = TecUtil.PageSetName(Name)

  Input:
                  Name                 string
  Output:
    Results[0]    ReturnVal            SetValueReturnCode_e  (defined in TecVals.py)

Since:

11.0-5-014

void TecUtilPaperGetDimensions	(	double *	Width,
		double *	Height
	)

Get the dimensions of the currently defined paper in the Tecplot workspace.

Parameters:

	Width	Width of the paper (in inches).
	Height	Height of the paper (in inches).

Fortran Syntax:

    SUBROUTINE TecUtilPaperGetDimensions(
   &           Width,
   &           Height)
    REAL*8          Width
    REAL*8          Height

Python Syntax:

  Results = TecUtil.PaperGetDimensions()

  Output:
    Results[0]    Width                double
    Results[1]    Height               double

Get the current paper's position and size:

   double width, height;
   TecUtilPaperGetDimensions(&width, &height);