PLGetGuideName

<< Click to Display Table of Contents >>

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

PLGetGuideName

Previous page Next page

PURPOSE

Retrieve the name of a guide for the specified guide index from the database.

SYNTAX

PLGetGuideName( DatabaseName, GuideIndex )

PARAMETERS

DatabaseName (Character String)

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

GuideIndex (Integer)

The guide index between 1 and number of guides

OUTPUT

A character string containing the name of the guide or one of the following error strings:

"Invalid Guide Number"

The Guide Index is out of range.

"Invalid Database"

The database cannot be opened.

SEE ALSO

Error Codes

PLGetGuideCount

PLGetGuideIndex

PLGetGuideSurfaceCount

PLGetGuideType

Back to Table of Contents