Navigation: Scripting Reference Manual > Functions & Subroutines > AddCatalogPrism

 

AddCatalogPrism

 

Contact Us: fredsupport@photonengr.com

 

Description

Adds a prism from a vendor catalog to the FRED document.

 

Syntax

n = AddCatalogPrism ( parent, name, catalog )

 

Parameters

n (Long)

The identifier of the newly added prism, or -1 if there is a problem.

 

parent As Long

Node number that will become the parent of the added prism.

 

name As String

The name of the prism.

 

catalog As String

The name of the catalog that holds the prism.

 

 

Remarks

This function adds a prism from a vendor catalog to the FRED document. If there is a problem the function sets an error and returns -1 without modifying the document. The allowed catalogs are "Edmund", "Esco", "JML", "Newport", "OptoSigma", and "Rolyn". Using other strings for catalog will result in an error.

 

See Also

AddCatalogLens

Examples

Elements

 

 

 

 

 

Copyright © Photon Engineering, LLC