PLGetLabelType

<< Click to Display Table of Contents >>

Navigation:  PipeLay > Excel Add-In > Function Reference > Label Functions >

PLGetLabelType

Previous page Next page

PURPOSE

Retrieve the Label Type for the specified label index.

SYNTAX

PLGetLabelType( DatabaseName, LabelIndex )

PARAMETERS

DatabaseName (Character String)

The full path and filename to the relevant database. The file extension is optional.

LabelIndex (Integer)

The index of the label to retrieve, between 1 and number of labels.

OUTPUT

An integer value containing the label type, 0 for node and 1 for element or one of the following error codes:

-999999999

Invalid Input (Label Index out of range).

-999999998

Invalid Database.

SEE ALSO

Error Codes

PLGetLabel

PLGetLabelCount

PLGetLabelNodeElementNo

PLGetLabelTypeForLabel

 

Back to Table of Contents