Symbol Definition Data
Functions Introduced:
• ProDtlsymdefdataAlloc()
• ProDtlsymdefdataFree()
• ProDtlsymdefdataIdGet()
• ProDtlsymdefdataHeighttypeGet()
• ProDtlsymdefdataHeighttypeSet()
• ProDtlsymdefdataTextrefSet()
• ProDtlsymdefdataTextrefGet()
• ProDtlsymdefdataElbowGet()
• ProDtlsymdefdataElbowSet()
• ProDtlsymdefdataTextangfixedGet()
• ProDtlsymdefdataTextangfixedSet()
• ProDtlsymdefdataScaledheightGet()
• ProDtlsymdefdataPathSet()
• ProDtlsymdefdataPathGet()
• ProDtlsymdefdataNameGet()
The opaque object ProDtlsymdefdata describes the contents of a symbol definition. The functions ProDtlsymdefdataAlloc() and ProDtlsymdefdataFree() allocate and free this data.
ProDtlsymdefdataIdGet() gives you the integer id of the symbol definition in Creo Parametric that the data describes. This will be set if the ProDtlsymdefdata has been acquired using ProDtlsymdefDataGet(). It is not necessary to set this when creating a symbol definition; the function ProDtlsymdefCreate() will assign an id to the new note.
ProDtlsymdefdataHeighttypeGet() and ProDtlsymdefdataHeighttypeSet() get and set the way in which the size of an instance of this symbol definition is set. The three types are:
• FIXED—The symbol instance height is fixed.
• VARIABLE—The symbol instance height may be modified by the Creo Parametric user.
• TEXTRELATED—The symbol instance height is related to the height of a text item in the definition.
If the height type is TEXTRELATED the functions ProDtlsymdefdataTextrefSet() and ProDtlsymdefdataTextrefGet() set and get the text item in the symbol definition which determines the symbol instance height. The reference is by note id, line index, and text item index.
ProDtlsymdefdataElbowGet() and ProDtlsymdefdataElbowSet() get and set the bit flag representing the elbow of the symbol definition.
ProDtlsymdefdataTextangfixedGet() and ProDtlsymdefdataTextangfixedSet() get and set whether the angle of text in the symbol is fixed.
ProDtlsymdefdataScaledheightGet() returns the height of the symbol definition in inches.
ProDtlsymdefdataPathSet() and ProDtlsymdefdataPathGet() set and get the path and file name of the file in which the symbol definition may be saved. This is used to give the symbol its name.
ProDtlsymdefdataNameGet() gets the name of the symbol definition.