On the following pages you will find an alphabetical list of the GPAs, their purpose, access type, data type, range, and the page number where you can find a complete description of their use.
The following are explanations of letters and/or characters which will be found in the RANGE column.
LT -- Less Than
LE -- Less Than Or Equal To
GT -- Greater Than
GE -- Greater Than Or Equal To
** -- Any valid Unigraphics numerical value
The following are explanations of letters and/or characters which will be found in the ACCESS and DATA TYPE columns.
N -- Number Valued
S -- String Valued
E -- Entity Valued
RW -- Read/Write
RO -- Read Only
C -- Constant (value which may not be changed)
NOTE: GPAs that access the file header to read data, must be preceded
by the FHREAD or DOPEN and DNEXT statements. These statements get the
information from the file header, and store it where the GPAs have access to it.
An asterisk (*) will appear next to all GPAs which require the use of FHREAD or
DOPEN and DNEXT.
Function |
Symbol |
Access Type |
Data Type |
Range |
ACCESS ABSOLUTE COORDINATE SYSTEM |
&ABS |
RO |
E |
|
ACTIVE PART STATUS
|
&ACTPRT |
RO |
N |
[1,2] =1 |
ALL AROUND SYMBOL DISPLAY
|
&ALARND &YES |
RW |
N C |
[1,2] =1 |
MODELING ANGLE TOLERANCE |
&ANGTOL |
RW |
N |
GT 0 |
APPENDED TEXT SITE
|
&APSITE &BELOW &AFTER &ABOVE &BEFORE &BEFAFT |
RW C |
N N |
[1..5] =1 |
RADIUS DIMENSION DISPLAY
|
&ARCCTR &YES |
RW C |
N N |
[1,2] =1 |
ARROW DISPLAY
|
&ARDSP &BOTH |
RW C |
N N |
[1..4] =1 |
ARROWHEAD FILL DISTANCE |
&ARFLDT |
RW |
N |
GT 0 |
ARROWHEAD INCLUDED ANGLE |
&ARIANG |
RW |
N |
GT 0 LT 180 |
ARC LENGTH SYMBOL
|
&ARLNSM &YES |
RW |
N C |
[1,2] =1 |
ARROWHEAD 1 TYPE
|
&ARROW &CLOSED |
RW C |
N N |
[1..6] =1 |
ARROWHEAD 2 TYPE
|
&ARROW2 &CLOSED |
RW C |
N N |
[1..6] =1 |
ARROWHEAD SIZE |
&ASIZE |
RW |
N |
GT 0 |
ASPECT RATIO |
&ASPECT |
RW |
N |
GT 0 |
ATTRIBUTE NAME DISPLAY
|
&ATTDIS &YES |
RW C |
N N |
[1,2] =1 |
ATTRIBUTE TYPE
|
&ATTYPE &INT |
RW C |
N N |
[1..7] =1 |
ANGULAR DIMENSION UNITS
|
&AUNIT &DECIM |
RW C |
N N |
[1..4] =1 |
CURRENT EXECUTION MODE
|
&BATCH |
RO |
N |
[1,2] =1 |
CUSTOMER AREA OF THE FILE HEADER |
&CAREA * |
RW |
S |
124 chars. |
BACKGROUND COLOR |
&BGCLR |
RW |
N |
[0.0-1.0] |
CHARACTER FONT |
&CFONT |
RW |
N |
GT 0 |
CHAINING METHOD
|
&CHAIN &SIMPLE |
RW C |
N N |
[1..4] =1 |
CHAINING TOLERANCE |
&CHTOL |
RW |
N |
[0..100] |
CLIPPING TOLERANCE |
&CLPTOL |
RW |
N |
[.001 - .10] |
COMPOSITE FRAME DISPLAY
|
&CMPFRM &YES |
RW |
N C |
[1,2] =1 |
CREATION MODE
|
&CNMODE &MODEL |
RW C |
N N |
[1,2] =1 |
CREATION DATE OF THE FILE DD-MM-YY |
&CRDATE* |
RO |
S |
8 chars. |
CREATION TIME OF THE FILE |
&CRTIME * |
RO |
S |
5 chars. |
CHARACTER SIZE |
&CSIZE |
RW |
N |
GT 0 |
CHARACTER SLANT IN DEG'S. |
&CSLANT |
RW |
N |
45° |
NEW COORDINATE SYSTEM STATUS |
&CSMODE |
RW |
N |
[1,2] |
NAME OF WORKING DIRECTORY |
&CURDIR |
RW |
S |
99 chars. |
CURRENT DRAWING |
&CURDRW |
RW |
S |
30 chars. |
CURRENT LAYOUT |
&CURLAY |
RW |
S |
30 chars. |
DASH SIZE |
&DASHSZ |
RW |
N |
GTE 0 |
DIMENSION PLACES PAST THE DECIMAL |
&DDECPL |
RW |
N |
[0..7] |
DUAL DIMENSION PLACES PAST THE DECIMAL |
&DDDECP |
RW |
N |
[0..7] |
SETS THE NUMBER OF DECIMAL PLACES FOR NUMERICAL DISPLAYS |
&DECPL |
RW |
N |
[0..9] |
DECIMAL POINT CHARACTER
|
&DECPT &PERIOD |
RW C |
N N |
[1,2] =1 |
COMMON FRACTION DENOMINATOR |
&DENOM |
RW |
N |
[1,2,4,8,16,32,64] |
DUAL FRACTION DENOMINATOR |
&DENOMD |
RW |
N |
[1,2,4,8, 16,32,64] |
DESCRIPTION AREA OF THE FILE HEADER |
&DESCR * |
RW |
S |
132 chars. |
DIAMETER SYMBOL |
&DIASYM |
RW |
S |
6 char's.** |
NAME OF LAST DIRECTORY OPENED BY DOPEN OR SOPEN |
&DIR * |
RO |
S |
10 chars. |
PATHNAME OF LAST DIRECTORY OPENED BY DOPEN OR SOPEN |
&DIRPTH * |
RO |
S |
99 chars. |
DISTANCE FROM DIM. LINE TO TEXT |
&DISTDT |
RW |
N |
GT 0 |
MODELING DISTANCE TOLERANCE |
&DISTOL |
RW |
N |
GT0 |
EXTENSION LINE DISTANCE TO REFERENCE POINT |
&DISTXR |
RW |
N |
GT 0 |
EXTENSION LINE DISTANCE PAST DIMENSION LINE |
&DISTXD |
RW |
N |
GT 0 |
LINE WIDTH (for dimensions)
|
&DLWID &NORMAL |
RW C |
N N |
[1..3] =1 |
OPTIONAL $ DIRECTORY |
&DOLLIB |
RW |
S |
99 chars. |
DIAMETER OF DOT ARROWHEAD |
&DOTDIA |
RW |
N |
GT 0 |
LN, AR, CSIZE RELATIONSHIP
|
&DPREL &YES |
RW C |
N N |
[1,2] =1 |
DIAMETER AND RADIUS SYMBOL SITE
|
&DRSITE &BELOW |
RW C |
N N |
[1..5] =1 |
CURRENT DRAWING STATE
|
&DSTATE |
RW C |
N N |
[1,2] =1 |
EXTENSION LINE DISTANCE TO SECOND REFERENCE POINT |
&DSTXR2 |
RW |
N |
GT 0 |
DUAL TOLERANCE PLACES PAST THE DECIMAL |
&DTDECP |
RW |
N |
[0..7] |
CURVE AND SHEET BODY DISPLAY TOLERANCE |
&DTOLC |
RW |
N |
GT 0 |
CURVE AND SHEET BODY DISPLAY TOLERANCE |
&DTOLS |
RW |
N |
GT 0 |
DUAL FORMAT
|
&DUAL &BELOW |
RW C |
N N |
[1..5] =1 |
DUAL LINEAR DIMENSION UNITS
|
&DUNITD &MM |
RW C |
N N |
[1..5] =1 |
LINEAR DIMENSION UNITS
|
&DUNIT &MM |
RW C |
N N |
[1..5] =1 |
CAM: LIST DUPLICATE MERGES
|
&DUPCAM &YES |
RW C |
N N |
[1,2] =1 |
OBJECT SITE RELATED TO TEXT
|
&ENSITE &TOPL |
RW C |
N N |
[1..9] =1 |
OBJECT COLOR
|
&ENTCLR &BLUE |
RW C |
N N |
[1..15] =1 |
PROCESS CONTROL IF ERRORS EXIST
|
&ERRMOD &TERM |
RW C |
N N |
[1,2] =1 |
RETURN LAST ERROR NUMBER |
&ERROR |
RO |
N |
Any Valid Error Number |
OPTIONAL ! DIRECTORY |
&EXCLIB |
RW |
S |
99 chars. |
EXPAND or UNEXPAND VIEW |
&EXPAND |
RW |
S |
30 chars |
FILLED ARROWHEAD DISPLAY
|
&FLARDP &YES |
RW C |
N N |
[1,2] =1 |
FAST FONT DISPLAY
|
&FASTF &YES |
RW C |
N N |
[1,2] =1 |
ARROWHEAD FILL CONTROL
|
&FILARW &YES |
RW C |
N N |
[1,2] =1 |
FILL PATTERN TYPE
|
&CORK |
C |
N |
[1..10] =1 |
LENGTH OF CURRENT FILE |
&FLEN * |
RO |
N |
GE 0 |
FRAME SIZE OF F&PT SYMBOL |
&FMSIZE |
RW |
N |
GT 0 |
NAME OF CURRENT FILE |
&FNAME * |
RW |
S |
30 chars. |
LINE FONT MODE
|
&FMODE |
RW |
N |
[1,2] =1 |
LINE FONT
|
&FONT &SOLID |
RW C |
N N |
[1..7] =1 |
LINE FONT NAME |
&FONTN |
RW |
S |
30 chars. |
FORMAT OF CURRENT FILE Binary CL
File |
&FORMAT* |
RO |
S |
4 chars. BCL |
FILE STATUS OF CURRENT FILE |
&FSTAT * |
RW |
N |
Any |
CURRENT FILE SYSTEM
|
&FSYS |
RO |
N N |
[2] =2 |
SET FULL DATE |
&FULLDT |
RW |
N |
[0..2] |
SPACE FACTOR |
&GAPFAC |
RW |
N |
GT 0 |
GRID BOUNDS-POLAR GRIDS |
&GBNDSP |
RW |
N |
[1..4] |
GRID BOUNDS-RECT. GRIDS |
&GBNDSR |
RW |
N |
[1..4] |
BATCH PARAMETER STRING |
&GBSTR |
RO |
S |
132 chars. |
GRID SIZE |
&GSIZE |
RW |
N |
GT 0 |
ANGULAR SPACING-POLAR GRIDS |
&GSIZEA |
RW |
N |
GT 0 |
RADIAL SPACING-POLAR GRIDS |
&GSIZER |
RW |
N |
GT 0 |
X-SPACING-RECTANGULAR GRIDS |
&GSIZEX |
RW |
N |
GT 0 |
Y-SPACING-RECTANGULAR GRIDS |
&GSIZEY |
RW |
N |
GT 0 |
GRID SNAP
|
&GSNAP &YES |
RW C |
N N |
[1,2] =1 |
GRID TYPE
|
>YPE &RECT |
RW C |
N N |
[1,2] =1 |
CROSSHATCH ANGLE |
&HANGLE |
RW |
N |
180° |
CROSSHATCH DISTANCE |
&HDIST |
RW |
N |
GT 0 |
CROSSHATCH MATERIAL TYPE
|
&HMAT &IRON |
RW C |
N N |
[1..10] =1 |
CROSSHATCH TOLERANCE |
&HTOLER |
RW |
N |
GT 0 |
ID-SYMBOL SIZE |
&IDSIZE |
RW |
N |
GT 0 |
FRACTION DISPLAY TYPE
|
&FTYPE &DECIM |
RW C |
N N |
[1..4] =1 |
DUAL FRACTION DISPLAY TYPE
|
&FTYPED &DECIM |
RW C |
N N |
[1..4] =1 |
OBJECT SITE INDICATOR
|
&INDIC &YES |
RW C |
N N N |
[1,2] =1 |
LAST ACCESSED DATE OF CURRENT FILE |
&LADATE * |
RO |
S |
8 chars. |
RETURN VALUE OF NATIVE LANGUAGE MENU NAME STRING |
&LANG |
RO |
S |
16 chars. |
LAST ACCESSED TIME OF CURRENT FILE |
&LATIME * |
RO |
S |
5 chars. |
LOCAL CHECKING OF SOLIDS
|
&LCHECK &OFF |
RW C |
N N |
[0..1] =0 |
LISTING DEVICE
|
&LDEV &CRT |
RO C |
N N |
[1..10] =1 |
LEADER ORIENTATION
|
&LEADER &LEFT |
RW C |
N N |
[1..3] =1 |
LINE FACTOR |
&LINFAC |
RW |
N |
GT 0 |
LAST MODIFIED DATE OF CURRENT FILE |
&LMDATE * |
RO |
S |
8 chars. |
LAST MODIFIED TIME OF CURRENT FILE |
&LMTIME * |
RO |
S |
5 chars. |
LINE BETWEEN ARROWS
|
&LNARRW &YES |
RW C |
N N |
[1,2] =1 |
CURRENT LINE BEING EXECUTED IN A GRIP PROGRAM |
&LNUM |
RO |
N |
GT 0 |
LINE WIDTH (for geometry)
|
&LWIDTH &NORMAL |
RW C |
N N |
[1..3] =1 |
MACHINE FORMAT OF CURRENT FILE
|
&MCHFMT* |
RO |
S |
GE 3 chars. DG |
OWNER OF CURRENT FILE |
&OWNER* |
RW |
S |
10 chars. |
PART OBJECT IDENTIFIER |
&PARATT |
RO |
E |
|
PATTERN MAX/MIN BOX DISPLAY STATUS
|
&PATBOX &YES |
RW C |
N N |
[1,2] =1 |
PATTERN CONTROL POINT DISPLAY STATUS
|
&PATCPT &YES |
RW C |
N N |
[1,2] =1 |
PATTERN ERRORS
|
&PATERR &YES |
RO C |
N N |
[1,2] =1 |
PATTERN DATA ARCHIVING
|
&PATFIL &YES |
RW C |
N N |
[1,2] =1 |
PATTERN ORIGIN MARKER DISPLAY STATUS
|
&PATMRK &YES |
RW C |
N N |
[1,2] =1 |
PATTERN SHADED DATA ARCHIVING
|
&PATSHD &YES |
RW C |
N N |
[1,2] =1 |
PROTECTION CLASS OF CURRENT FILE |
&PCLASS * |
RW |
S |
8 chars. |
POSITION INDICATOR TYPE
|
&PITYPE &CURSOR |
RW C |
N N |
[0,1] =0 |
CURRENT PLATFORM
|
&PLTFRM |
RO |
N |
[1..15] =1 |
CURRENT PART NAME |
&PNAME |
RW |
S |
30 chars. |
CURRENT FILE SPECIFICATION |
&PSPEC |
RW |
S |
132 chars. |
RADIUS SYMBOL |
&RADSYM |
RW |
S |
6 char's. ** |
EXPRESSIONS A-L
*Any real number |
®A |
RW |
N |
* |
RELEASE NUMBER OF CURRENT FILE |
&RELNO * |
RO |
S |
GE 7 chars.
V1 |
RETAIN ANNOTATIONS |
&RETANN |
RW |
N |
[0,1] |
RUNOUT FILLED ARROWHEAD DISPLAY
|
&RNFILL &YES |
RW |
N C |
[1,2] =1 |
RUNOUT ARROWHEAD FILLED DISTANCE |
&RNDIST |
RW |
N |
GT 0 |
SYMBOL DISPLAY MODE IN LINE FONT
|
&SBDISP &YES |
RW C |
N N |
[1,2] =1 |
SOLID DENSITY |
&SDENS |
RW |
N |
GE 0 |
SOLID DENSITY UNITS
|
&SDUNIT &LBIN |
RW C |
N N |
[1..4] =1 |
NUMBER OF SURFACE GRIDS IN U DIRECTION |
&SGRIDU |
RW |
N |
GE 0 |
NUMBER OF SURFACE GRIDS 4 IN V DIRECTION |
&SGRIDV |
RW |
N |
GE 0 |
SPACE SIZE |
&SPCSZ |
RW |
N |
GE 0 |
SPECKLE TOLERANCE |
&SPKTOL |
RW |
N |
[.001 - .10] |
STUBB SIZE |
&STUBB |
RW |
N |
GE 0 |
TRAILING ZERO SUPPRESSION
|
&SUPRES &YES |
RW C |
N N |
[1,2] =1 |
SYMBOL SIZE |
&SYMBSZ |
RW |
N |
GT 0 |
DISTANCE BETWEEN TEXT AND DIAMETER SYMBOL |
&SYMDIS |
RW |
N |
GE 0 |
SYSTEM COLOR
|
&SYSCLR &BLUE |
RW C |
N N |
[1..15] =1 |
TOLERANCE PLACES PAST THE DECIMAL |
&TDECPL |
RW |
N |
[0..7] |
TEXT BOX DISPLAY
|
&TEXBOX &YES |
RW C |
N N |
[1,2] =1 |
TEXT ORIENTATION Horizontal |
&TEXTOR &TXHOR |
RW C |
N N |
[1..5] =1 |
TEXT LINE WIDTH
|
&TLWID &NORMAL
&THICK |
RW C |
N N |
[1..3] =1 |
TOLERANCE TYPE
|
&TOLER &NOTOL |
RW C |
N N |
[1..11] =1 |
TOLERANCE VALUE
(English): |
&TOLOW |
RW |
N |
Infinity |
TOLERANCE VALUE
(Metric): |
&TOLOWM |
RW |
N |
Infinity |
TOLERANCE VALUE
(English): |
&TOLUP |
RW |
N |
Infinity |
TOLERANCE VALUE(Metric): UPPER |
&TOLUPM |
RW |
N |
Infinity |
TOLERANCE SITE
|
&TOSITE &BELOW |
RW C |
N N |
[1..3] =1 |
TEXT ANGLE |
&TXANGL |
RW |
N |
360° |
TEXT AND ARROW LOCATION
|
&TXARR &AUTO |
RW C |
N N |
[1..3] =1 |
TEXT JUSTIFICATION
|
&TXJUST &LEFT |
RW C |
N N |
[1..3] =1 |
READ USER EXIT NUMBER |
&UENUM |
RO |
N |
[1..58] |
ACCESS USER EXIT STRING |
&UESTR |
RW |
S |
132 chars. |
ACCESS USER EXIT CODE |
&UEXERR |
RW |
N |
[-2..3] |
DETERMINE IF UG/MANAGER IS RUNNING |
&UGMGR |
RO |
N |
[1,2] |
CURRENT UGII VERSION |
&UGVERS |
RO |
S |
GE 5 |
UNIT OF MEASUREMENT
|
&UNIT |
RO |
N |
[1,2] =1 |
USER IDENTIFICATION STRING |
&USERID |
RO |
S |
30 chars. |
VERTICAL TEXT JUSTIFICATION
|
&VTXJST &TOP |
RW C |
N N |
[1..3] =1 |
VIEW OF CURSOR FOR SELECTION
|
&VWCURS &ANY |
RW C |
N N |
[1,2] =1 |
RETURN VIEW OF LAST SELECTION |
&VWSEL |
RO |
S |
30 chars. |
DISPLAY VIEW BORDERS AND NAMES
|
&WBORD &YES |
RW C |
N N |
[1,2] =1 |
WORK COORDINATE SYSTEM OBJECT |
&WCS |
RW |
E |
|
DISPLAY TEMPORARY WCS
|
&WCSDRW &YES |
RW C |
N N |
[1,2] =1 |
LINE WIDTH DISPLAY
|
&WIDDSP &YES |
RW C |
N N |
[1,2] =1 |
CURRENT WORK LAYER |
&WLAYER |
RW |
N |
[1..256] |
CURRENT WORK VIEW |
&WVIEW |
RO |
N |
GE 0 |
CHANGE WORK VIEW |
&WORKVW |
RW |
S |
30 chars. |
EXTENSION LINE DISPLAY
|
&XLINE &BOTH |
RW C |
N N |
[1..4] =1 |