PCL Reference Manual > Basic Functions > Display Menu
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX''">XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX''">   
Display Menu
This section is used to describe functions that are used to control the values stored in the database that govern what and how geometric and finite element model entities are displayed in a viewport.
 
ga_display_autosubdivconst_get
(display_name, tolerance)
 
Description:
This function gets the subdivision tolerance value used in conjunction with setting the ranges for spectrums used to display results.
Input:
STRING
display_name[31]
This value specifies the name of the display property list from which the requested data value will be obtained.
Output:
REAL
tolerance
This value returns the range subdivision tolerance value.
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000042
The display property list is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
13000016
Display not found
Remarks:
None.
Example:
Please see ga_display_autosubdivconst_get (p. 175) in the PCL Reference Manual Examples.
  
ga_display_autosubdivconst_set
(display_name, tolerance)
 
Description:
This function sets the subdivision tolerance value used in conjunction with setting the ranges for spectrums used to display results.
Input:
STRING
display_name[31]
This value specifies the name of the display property list to which the requested data value will be set.
REAL
tolerance
This value specifies the range subdivision tolerance value.
Output:
 
 
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions:
 
This is only a partial list of the error values that can be returned by this function.
11000042
The display property list is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_autosubdivconst_set (p. 176) in the PCL Reference Manual Examples.
 
ga_display_autosubdivide_get
(display_name, autosubdivide_status)
 
Description:
 
 
This function gets the status of the autosubdivide flag used in storing the value of a setting for the range used with spectrums used to display results.
Input:
 
 
STRING
display_name[31]
This value specifies the name of the display property list from which the requested data value will be obtained.
Output:
 
 
INTEGER
autosubdivide_status
This value returns the autosubdivide and can be any value.
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions:
 
This is only a partial list of the error values that can be returned by this function.
11000042
The display property list is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_autosubdivide_get (p. 178) in the PCL Reference Manual Examples.
 
ga_display_autosubdivide_set
(display_name, autosubdivide_status)
 
Description:
 
 
This function sets the status of the autosubdivide flag used in storing the value of a setting for the range used with spectrums to display results.
Input:
 
 
STRING
display_name[31]
This value specifies the name of the display property list to which the requested data value will be set.
INTEGER
autosubdivide_status
This value specifies the autosubdivide status and can be set to any value.
Output:
 
 
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions:
 
This is only a partial list of the error values that can be returned by this function.
11000042
The display property list is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_autosubdivide_set (p. 179) in the PCL Reference Manual Examples.
 
ga_display_backfacing_get
(display_name, backface_status)
 
Description:
 
 
This function gets the status of the value used to control the display of back facing polygons.
Input:
 
 
STRING
display_name[31]
This value specifies the name of the display property list from which the requested data value will be obtained.
Output:
 
 
INTEGER
backface_status
This value returns the status for the display of back facing polygons. This argument may be set to any value.
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions:
 
This is only a partial list of the error values that can be returned by this function.
11000042
The display property list is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_backfacing_get (p. 180) in the PCL Reference Manual Examples.
 
ga_display_backfacing_set
(display_name, backface_status)
Description:
 
 
This function sets the value used to control the display of back facing polygons.
Input:
 
 
STRING
display_name[31]
This value specifies the name of the display property list to which the requested data value will be set.
INTEGER
backface_status
This value specifies the status for the display of back facing polygons. It can be set to any value.
Output:
 
 
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions:
 
This is only a partial list of the error values that can be returned by this function.
11000042
The display property list is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_backfacing_set (p. 182) in the PCL Reference Manual Examples.
 
ga_display_bumpmap_get
(display_name, bump_map_id, bump_map_number)
 
Description:
 
 
This function gets the bump map parameters for the named display property list.
Input:
 
 
STRING
display_name[31]
This value specifies the name of the display property list from which the requested data value will be obtained.
Output:
 
 
INTEGER
bump_map_id
This value returns the bump map ID.
INTEGER
bump_map_number
This value returns the number of bump maps per surface.
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions:
 
This is only a partial list of the error values that can be returned by this function.
11000042
The display property list is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_bumpmap_get (p. 183) in the PCL Reference Manual Examples.
 
ga_display_bumpmap_set
(display_name, bump_map_id, bump_map_number)
Description:
 
 
This function sets the bump map parameters for the named display property list.
Input:
 
 
STRING
display_name[31]
This value specifies the name of the display property list to which the requested data value will be set.
INTEGER
bump_map_id
This value specifies the ID number identifying a specific bump map.
INTEGER
bump_map_number
This value specifies the number of bump maps per surface.
Output:
 
 
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions:
 
This is only a partial list of the error values that can be returned by this function.
11000042
The display property list is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_bumpmap_set (p. 184) in the PCL Reference Manual Examples.
 
ga_display_contour_lblspcng_get
(display_name, label_spacing)
 
Description:
 
 
This function gets the label spacing for contour plots from the named display property list.
Input:
 
 
STRING
display_name[31]
This value specifies the name of the display property list from which the requested data value will be obtained.
Output:
 
 
INTEGER
label_spacing
This value returns the label spacing for contour plots. This value will always be greater than zero.
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions:
 
This is only a partial list of the error values that can be returned by this function.
11000042
The display property list is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_contour_lblspcng_get (p. 186) in the PCL Reference Manual Examples.
 
ga_display_contour_lblspcng_set
(display_name, label_spacing)
 
Description:
 
 
This function sets the label spacing for contour plots for the named display property list.
Input:
 
 
STRING
display_name[31]
This value specifies the name of the display property list to which the requested data value will be set.
INTEGER
label_spacing
This value specifies the label spacing for contour plots. This value must be greater than zero or an error condition will be returned.
Output:
 
 
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions:
 
This is only a partial list of the error values that can be returned by this function.
11000042
The display property list is invalid.
11000091
The specified contour label spacing is not valid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_contour_lblspcng_set (p. 187) in the PCL Reference Manual Examples.
 
ga_display_create
(display_name)
Description:
 
 
This function will create a named display property list using display property list assigned the current group for its default values.
Input:
 
 
STRING
display_name[31]
This value specifies the name of the display property list to be created.
Output:
 
 
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions:
 
This is only a partial list of the error values that can be returned by this function.
11000041
A display property list with the given name is already in the database.
11000042
The display property list is invalid.
11000097
There is not enough disk space to complete operation.
11000098
A fatal error has occurred in the database. Database is corrupted.
13000007
An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_create (p. 188) in the PCL Reference Manual Examples.
 
ga_display_deform_scale_get
(display_name, deformation_scale)
 
Description:
 
 
This function gets the deformation scale for the named display property list.
Input:
 
 
STRING
display_name[31]
This value specifies the name of the display property list from which the requested data value will be obtained.
Output:
 
 
REAL
deformation_scale
This value returns the deformation scale value.
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions:
 
This is only a partial list of the error values that can be returned by this function.
11000042
The display property list is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_deform_scale_get (p. 189) in the PCL Reference Manual Examples.
 
ga_display_deform_scale_set
(display_name, deformation_scale)
 
Description:
 
 
This function sets the deformation scale for the named display property list.
Input:
 
 
STRING
display_name[31]
This value specifies the name of the display property list to which the requested data value will be set.
REAL
deformation_scale
This value specifies the deformation scale for the named display property list.
Output:
 
 
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions:
 
This is only a partial list of the error values that can be returned by this function.
11000042
The display property list is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_deform_scale_set (p. 191) in the PCL Reference Manual Examples.
 
ga_display_deform_scalintrp_get
(display_name, interpretation)
 
Description:
 
 
This function gets the interpretation of the deformation scale for the named display property list.
Input:
 
 
STRING
display_name[31]
This value specifies the name of the display property list from which the requested data value will be obtained.
Output:
 
 
STRING
interpretation[31]
This value returns the deformation scale interpretation string which can have a value of either “VALUE”, or “PERCENTAGE”.
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions:
 
This is only a partial list of the error values that can be returned by this function.
11000042
The display property list is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_deform_scalintrp_get (p. 192) in the PCL Reference Manual Examples.
 
ga_display_deform_scalintrp_set
(display_name, interpretation)
Description:
 
 
This function will set the interpretation value for the deformed entity scale for the named display property list.
Input:
 
 
STRING
display_name[31]
This value specifies the name of the display property list to which the requested data value will be set.
STRING
interpretation[31]
This value specifies the interpretation value. This string can have either be set to “VALUE” or “PERCENTAGE”.
Output:
 
 
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions:
 
This is only a partial list of the error values that can be returned by this function.
11000042
The display property list is invalid.
11000093
The specified deform scale interpretation is not valid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_deform_scalintrp_set (p. 193) in the PCL Reference Manual Examples.
 
ga_display_delete
(display_name)
 
Description:
 
 
This function will delete the named display property list.
Input:
 
 
STRING
display_name[31]
This value specifies the name of the display property list from which the requested data value will be obtained.
Output:
 
 
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions:
 
This is only a partial list of the error values that can be returned by this function.
11000042
The display property list is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
11000141
The Display Property is in use by the model or is assigned to a group.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_delete (p. 194) in the PCL Reference Manual Examples.
  
ga_display_diffuse_get
(display_name, diffuse_reflectance)
 
Description:
 
 
This function will get the diffuse reflectance value for the named display property list.
Input:
 
 
STRING
display_name[31]
This value specifies the name of the display property list from which the requested data value will be obtained.
Output:
 
 
REAL
diffuse_reflectance
This value returns the diffuse reflectance value for the named display property list.
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions:
 
This is only a partial list of the error values that can be returned by this function.
11000042
The display property list is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_diffuse_get (p. 195) in the PCL Reference Manual Examples.
 
ga_display_diffuse_set
(display_name, diffuse_reflectance)
 
Description:
 
 
Set the diffuse reflectance.
Input:
 
 
STRING
display_name[31]
This value specifies the name of the display property list to which the requested data value will be set.
REAL
diffuse_reflectance
This value specifies the diffuse reflectance for the named display property list.
Output:
 
 
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions:
 
This is only a partial list of the error values that can be returned by this function.
11000042
The display property list is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_diffuse_set (p. 197) in the PCL Reference Manual Examples.
 
ga_display_displays_get
(display_list)
 
Description:
 
 
This function will get a list of all of the defined named display property lists.
Input:
 
 
None.
Output:
 
 
STRING
display_list[31]()
This value returns a list of all defined display property lists. See the remarks below for more information.
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions:
 
This is only a partial list of the error values that can be returned by this function.
11000098
A fatal error has occurred in the database. Database is corrupted.
13000085
Cursor not open
Remarks:
The output value display_list must be allocated with enough offsets available to contain the entire list. The number of offsets needed can be obtained through a call to the function ga_display_ndisplays_get.
Example:
Please see ga_display_displays_get (p. 198) in the PCL Reference Manual Examples.
 
ga_display_edgecolor_get
(display_name, color_index)
 
Description:
 
 
This function will get the edge color attributes used in shading for the named display property list.
Input:
 
 
STRING
display_name[31]
This value specifies the name of the display property list from which the requested data value will be obtained.
Output:
 
 
INTEGER
color_index
This value returns the color index for the edges of the named display property list.
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions:
 
This is only a partial list of the error values that can be returned by this function.
11000042
The display property list is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_edgecolor_get (p. 199) in the PCL Reference Manual Examples.
  
ga_display_edgecolor_set
(display_name, color_index)
 
Description:
 
 
This function will set the edge color attributes used in shading for the named display property list.
Input:
 
 
STRING
display_name[31]
This value specifies the name of the display property list to which the requested data value will be set.
INTEGER
color_index
This value specifies the edge color attributes for the named display property list.
Output:
 
 
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions:
 
This is only a partial list of the error values that can be returned by this function.
11000042
The display property list is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_edgecolor_set (p. 200) in the PCL Reference Manual Examples.
  
ga_display_exist_get
(display_name, display_status)
 
Description:
 
 
This function is used to check for the existence of a named display property list.
Input:
 
 
STRING
display_name[31]
This value specifies the name of the display property list from which the requested data value will be obtained.
Output:
 
 
INTEGER
display_status
This value returns the existence of the named display property list. It will be set to 0 or FALSE if the list does not exist and it will be set to 1 or TRUE if the list exists.
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions:
 
This is only a partial list of the error values that can be returned by this function.
11000042
The display property list is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_exist_get (p. 201) in the PCL Reference Manual Examples.
  
ga_display_freefem_get
(display_name, style)
 
Description:
 
 
This function will get the free FEM characteristics display style attribute from the named display property list.
Input:
 
 
STRING
display_name[31]
This value specifies the name of the display property list from which the requested data value will be obtained.
Output:
 
 
INTEGER
style
This value returns the free FEM display style for the named display property list.
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions:
 
This is only a partial list of the error values that can be returned by this function.
11000042
The display property list is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_freefem_get (p. 202) in the PCL Reference Manual Examples.
 
ga_display_freefem_set
(display_name, style)
 
Description:
 
 
This function will set the free FEM characteristics display style attribute for the named display property list.
Input:
 
 
STRING
display_name[31]
This value specifies the name of the display property list to which the requested data value will be set.
INTEGER
style
This value specifies the free FEM display style for the named display property list.
Output:
 
 
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions:
 
This is only a partial list of the error values that can be returned by this function.
11000042
The display property list is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_freefem_set (p. 204) in the PCL Reference Manual Examples.
 
ga_display_gloss_get
(display_name, gloss_value)
Description:
 
 
This function will get the amount of glossiness for the named display property list.
Input:
 
 
STRING
display_name[31]
This value specifies the name of the display property list from which the requested data value will be obtained.
Output:
 
 
REAL
gloss_value
This value returns the gloss value for the named display property list.
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions:
 
This is only a partial list of the error values that can be returned by this function.
11000042
The display property list is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_gloss_get (p. 205) in the PCL Reference Manual Examples.
  
ga_display_gloss_set
(display_name, gloss_value)
 
Description:
 
 
This function will set the amount of gloss for the named display property list.
Input:
 
 
STRING
display_name[31]
This value specifies the name of the display property list to which the requested data value will be set.
REAL
gloss_value
This value specifies the gloss for the named display property list.
Output:
 
 
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions:
 
This is only a partial list of the error values that can be returned by this function.
11000042
The display property list is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_gloss_set (p. 207) in the PCL Reference Manual Examples.
  
ga_display_gravitation_get
(display_name, gravity_status)
 
Description:
 
 
This function gets the on/off status for the display of gravitational points for the named display property list.
Input:
 
 
STRING
display_name[31]
This value specifies the name of the display property list from which the requested data value will be obtained.
Output:
 
 
INTEGER
gravity_status
This value returns the on/off status for the display of gravitational points and can be of any value.
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions:
 
This is only a partial list of the error values that can be returned by this function.
11000042
The display property list is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_gravitation_get (p. 208) in the PCL Reference Manual Examples.
 
ga_display_gravitation_set
(display_name, gravity_status)
 
Description:
 
 
This function sets the on/off status for the display of gravitational points for the named display property list.
Input:
 
 
STRING
display_name[31]
This value specifies the name of the display property list to which the requested data value will be set.
INTEGER
gravity_status
This value specifies the on/off status used to control the display of gravitational points and can be of any value.
Output:
 
 
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions:
 
This is only a partial list of the error values that can be returned by this function.
11000042
The display property list is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_gravitation_set (p. 209) in the PCL Reference Manual Examples.
 
ga_display_hilight_get
(display_name, specular_value)
 
Description:
 
 
This function will get the value used to control specular reflections for the named display property list.
Input:
 
 
STRING
display_name[31]
This value specifies the name of the display property list from which the requested data value will be obtained.
Output:
 
 
INTEGER
specular_value
This value returns the state of the value used to control specular reflections.
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions:
 
This is only a partial list of the error values that can be returned by this function.
11000042
The display property list is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_hilight_get (p. 210) in the PCL Reference Manual Examples.
 
ga_display_hilight_set
(display_name, specular_value)
 
Description:
 
 
This function will set the value used to control specular reflections for the named display property list.
Input:
 
 
STRING
display_name[31]
This value specifies the name of the display property list to which the requested data value will be set.
INTEGER
specular_value
This value specifies the state of the value used to control specular reflections.
Output:
 
 
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions:
 
This is only a partial list of the error values that can be returned by this function.
11000042
The display property list is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_hilight_set (p. 211) in the PCL Reference Manual Examples.
  
ga_display_labelcolor_get
(display_name, label_color)
 
Description:
 
 
This function will get the label color for the named display property list.
Input:
 
 
STRING
display_name[31]
This value specifies the name of the display property list from which the requested data value will be obtained.
Output:
 
 
INTEGER
label_color
This value returns the label color for the named display property list.
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions:
 
This is only a partial list of the error values that can be returned by this function.
11000042
The display property list is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_labelcolor_get (p. 213) in the PCL Reference Manual Examples.
 
ga_display_labelcolor_set
(display_name, label_color)
Description:
 
 
This function sets the label color for the named display property list.
Input:
 
 
STRING
display_name[31]
This value specifies the name of the display property list to which the requested data value will be set.
INTEGER
label_color
This value specifies the label color.
Output:
 
 
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions:
 
This is only a partial list of the error values that can be returned by this function.
11000042
The display property list is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_labelcolor_set (p. 214) in the PCL Reference Manual Examples.
 
ga_display_lines_get
(display_name, line_number)
 
Description:
 
 
This function gets the number of visualization lines from the named display property list.
Input:
 
 
STRING
display_name[31]
This value specifies the name of the display property list from which the requested data value will be obtained.
Output:
 
 
INTEGER
line_number
This value returns the number of visualization lines.
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions:
 
This is only a partial list of the error values that can be returned by this function.
11000042
The display property list is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_lines_get (p. 215) in the PCL Reference Manual Examples.
 
ga_display_lines_set
(display_name, line_number)
 
Description:
 
 
This function will set the number of visualization lines for the named display property list.
Input:
 
 
STRING
display_name[31]
This value specifies the name of the display property list to which the requested data value will be set.
INTEGER
line_number
This value specifies the number of visualization lines.
Output:
 
 
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions:
 
This is only a partial list of the error values that can be returned by this function.
11000042
The display property list is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_lines_set (p. 217) in the PCL Reference Manual Examples.
 
ga_display_linestyle_get
(display_name, line_style)
 
Description:
 
 
This function will get the line style for the named display property list.
Input:
 
 
STRING
display_name[31]
This value specifies the name of the display property list from which the requested data value will be obtained.
Output:
 
 
STRING
line_style[31]
This value returns one of the two values, “SOLID”, or “DASHED”, that are used to specify the line style.
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions:
 
This is only a partial list of the error values that can be returned by this function.
11000042
The display property list is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_linestyle_get (p. 218) in the PCL Reference Manual Examples.
  
ga_display_linestyle_set
(display_name, line_style)
 
Description:
 
 
Set the curve style.
Input:
 
 
STRING
display_name[31]
This value specifies the name of the display property list to which the requested data value will be set.
STRING
line_style[31]
This value specifies the line_style and it should be set to one of the two supported values: “SOLID”, or “DASHED”. These two values are not case sensitive.
Output:
 
 
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions:
 
This is only a partial list of the error values that can be returned by this function.
11000042
The display property list is invalid.
11000043
The specified line style is not valid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_linestyle_set (p. 219) in the PCL Reference Manual Examples.
  
ga_display_linewidth_get
(display_name, line_width)
 
Description:
 
 
This function will get the line width for the named display property list. See remarks below.
Input:
 
 
STRING
display_name[31]
This value specifies the name of the display property list from which the requested data value will be obtained.
Output:
 
 
INTEGER
line_width
This value returns the line width for the named display property list.
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions:
 
This is only a partial list of the error values that can be returned by this function.
11000042
The display property list is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks:
This function does nothing and does not modify the initial value of the input value line_width.
Example:
Please see ga_display_linewidth_get (p. 220) in the PCL Reference Manual Examples.
 
ga_display_linewidth_set
(display_name, line_width)
 
Description:
 
 
This function will set the line width for the named display property list.
Input:
 
 
STRING
display_name[31]
This value specifies the name of the display property list to which the requested data value will be set.
INTEGER
line_width
This value specifies the line width for the named display property list.
Output:
 
 
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions:
 
This is only a partial list of the error values that can be returned by this function.
11000042
The display property list is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks:
This function does nothing and does not make any use of the input value line_width.
Example:
Please see ga_display_linewidth_set (p. 221) in the PCL Reference Manual Examples.
  
ga_display_ndisplays_get
(number_of_displays)
 
Description:
 
 
This function will get the number of named display properties currently defined.
Input:
None.
Output:
 
 
INTEGER
number_of_displays
This value returns the number of display properties.
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions:
 
This is only a partial list of the error values that can be returned by this function.
11000098
A fatal error has occurred in the database. Database is corrupted.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
13000085
Cursor not open
Remarks:
None.
Example:
Please see ga_display_ndisplays_get (p. 222) in the PCL Reference Manual Examples.
 
ga_display_nlspc_get
(display_name, number_of_segments)
 
Description:
 
 
This function will get the number of line segments per curve for the named display property list.
Input:
 
 
STRING
display_name[31]
This value specifies the name of the display property list from which the requested data value will be obtained.
Output:
 
 
INTEGER
number_of_segments
This value returns the number of line segments per curve.
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions:
 
This is only a partial list of the error values that can be returned by this function.
11000042
The display property list is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_nlspc_get (p. 223) in the PCL Reference Manual Examples.
 
ga_display_nlspc_set
(display_name, number_of_segments)
 
Description:
 
 
This function will set the number of line segments per curve for the named display property list.
Input:
 
 
STRING
display_name[31]
This value specifies the name of the display property list to which the requested data value will be set.
INTEGER
number_of_segments
This value specifies the number of line segments per curve.
Output:
 
 
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions:
 
This is only a partial list of the error values that can be returned by this function.
11000042
The display property list is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_nlspc_set (p. 224) in the PCL Reference Manual Examples.
 
ga_display_nspe_get
(display_name, number_of_segments)
 
Description:
 
 
This function will get the number of line segments per edge for the named display property list.
Input:
 
 
STRING
display_name[31]
This value specifies the name of the display property list from which the requested data value will be obtained.
Output:
 
 
INTEGER
number_of_segments
This argument returns the number of line segments per edge.
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions:
 
This is only a partial list of the error values that can be returned by this function.
11000042
The display property list is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_nspe_get (p. 226) in the PCL Reference Manual Examples.
  
ga_display_nspe_set
(display_name, number_of_segments)
 
Description:
This function will set the number of line segments per edge for the named display property list.
Input:
STRING
display_name[31]
This value specifies the name of the display property list to which the requested data value will be set.
INTEGER
number_of_segments
This values specifies the number of line segments per edge.
Output:
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000042
The display property list is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_nspe_set (p. 227) in the PCL Reference Manual Examples.
 
ga_display_offsets_get
(display_name, offset_status)
 
Description:
This function controls the on/off status of the offset for the display of element properties for the named display property list.
Input:
STRING
display_name[31]
This value specifies the name of the display property list from which the requested data value will be obtained.
Output:
INTEGER
offset_status
This argument returns the on/off status of the offset for the display of element properties. This argument may be any of any value.
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000042
The display property list is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_offsets_get (p. 229) in the PCL Reference Manual Examples.
 
ga_display_offsets_set
(display_name, offset_status)
 
Description:
 
 
This function will set the on/off status of the offset for the display of element properties for the named display property list.
Input:
 
 
STRING
display_name[31]
This value specifies the name of the display property list to which the requested data value will be set.
INTEGER
offset_status
This value specifies the on/off status for the display of element properties. This argument can be set to any value.
Output:
 
 
 
 
 
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions:
 
This is only a partial list of the error values that can be returned by this function.
11000042
The display property list is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_offsets_set (p. 231) in the PCL Reference Manual Examples.
 
ga_display_parametric_get
(display_name, parametric_status)
 
Description:
 
 
This function gets the on/off status for the display of parametric directions for the named display property list.
Input:
 
 
STRING
display_name[31]
This value specifies the name of the display property list from which the requested data value will be obtained.
Output:
 
 
INTEGER
parametric_status
This value returns the on/off status for the display of parametric directions. This argument can return any value.
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions:
 
This is only a partial list of the error values that can be returned by this function.
11000042
The display property list is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_parametric_get (p. 232) in the PCL Reference Manual Examples.
  
ga_display_parametric_set
(display_name, parametric_status)
 
Description:
 
 
This function will set the on/off status for the display of parametric directions for the named display property list.
Input:
 
 
STRING
display_name[31]
This value specifies the name of the display property list to which the requested data value will be set.
INTEGER
parametric_status
This values specifies the on/off status for the display of parametric directions.
Output:
 
 
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions:
 
This is only a partial list of the error values that can be returned by this function.
11000042
The display property list is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_parametric_set (p. 234) in the PCL Reference Manual Examples.
  
ga_display_rename
(original_name, new_name)
 
Description:
 
 
This function will rename the named display property list.
Input:
 
 
STRING
original_name[]
This value specifies the original name of the display property list.
STRING
new_name[]
This value specifies the new name of the display property list.
Output:
 
 
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions:
 
This is only a partial list of the error values that can be returned by this function.
11000042
The display property list is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_rename (p. 235) in the PCL Reference Manual Examples.
 
ga_display_result_label_get
(display_name, result_label_status)
 
Description:
 
 
This function will get the on/off status value for the named display property list that is used to control the display of results labels.
Input:
 
 
STRING
display_name[31]
This value specifies the name of the display property list from which the requested data value will be obtained.
Output:
 
 
INTEGER
result_label_status
This value returns the on/off status used to control the display of results labels. This argument can return any value.
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions:
 
This is only a partial list of the error values that can be returned by this function.
11000042
The display property list is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_result_label_get (p. 236) in the PCL Reference Manual Examples.
 
ga_display_result_label_set
(display_name, result_label_status)
 
Description:
 
 
This function is used to set the on/off status value for the named display property list that is used to control the display of results labels.
Input:
 
 
STRING
display_name[31]
This value specifies the name of the display property list to which the requested data value will be set.
INTEGER
result_label_status
This value specifies the status value that controls the display of results labels. This argument can be of any value.
Output:
 
 
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions:
 
This is only a partial list of the error values that can be returned by this function.
11000042
The display property list is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_result_label_set (p. 237) in the PCL Reference Manual Examples.
  
ga_display_result_lblformat_get
(display_name, label_format)
 
Description:
 
 
This function will get the format value of the result labels for the named display property list.
Input:
 
 
STRING
display_name[31]
This value specifies the name of the display property list from which the requested data value will be obtained.
Output:
STRING
label_format[31]
This value returns the result label format value which can be set to either “LETTER” or “VALUE”.
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000042
The display property list is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_result_lblformat_get (p. 239) in the PCL Reference Manual Examples.
  
ga_display_result_lblformat_set
(display_name, label_format)
 
Description:
 
 
This function will set the format value of the results labels for the named display property list.
Input:
 
 
STRING
display_name[31]
This value specifies the name of the display property list to which the requested data value will be set.
STRING
label_format[31]
This value specifies the result label format. This argument can be set to a case insensitive value of either “LETTER”, or “VALUE”.
Output:
 
 
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions:
 
This is only a partial list of the error values that can be returned by this function.
11000042
The display property list is invalid.
11000092
The specified result label format is not valid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_result_lblformat_set (p. 240) in the PCL Reference Manual Examples.
 
ga_display_showedges_get
(display_name, edges_status)
 
Description:
 
 
This function will get the on/off status of the value used to control the display of edges for the named display property list.
Input:
 
 
STRING
display_name[31]
This value specifies the name of the display property list from which the requested data value will be obtained.
Output:
 
 
INTEGER
edges_status
This value returns the on/off status used to control the display of edges. This argument can be of any value.
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions:
 
This is only a partial list of the error values that can be returned by this function.
11000042
The display property list is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_showedges_get (p. 241) in the PCL Reference Manual Examples.
 
ga_display_showedges_set
(display_name, edges_status)
Description:
 
 
This function will set the on/off status of the value used to control the display of edges for the named display property list.
Input:
 
 
STRING
display_name[31]
This value specifies the name of the display property list to which the requested data value will be set.
INTEGER
edges_status
This value specifies the on/off status used to control the display of edges. This argument can be set to any value.
Output:
 
 
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions:
 
This is only a partial list of the error values that can be returned by this function.
11000042
The display property list is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_showedges_set (p. 243) in the PCL Reference Manual Examples.
 
ga_display_shrfem_get
(display_name, shrink_factor)
 
Description:
 
 
This function gets the shrink factor used in the display of finite elements for the named display property list.
Input:
 
 
STRING
display_name[31]
This value specifies the name of the display property list from which the requested data value will be obtained.
Output:
 
 
REAL
shrink_factor
This value returns the shrink factor.
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions:
 
This is only a partial list of the error values that can be returned by this function.
11000042
The display property list is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_shrfem_get (p. 244) in the PCL Reference Manual Examples.
  
ga_display_shrfem_set
(display_name, shrink_factor)
 
Description:
 
 
This function sets the shrink factor used in the display of finite elements for the named display property list.
Input:
 
 
STRING
display_name[31]
This value specifies the name of the display property list to which the requested data value will be set.
REAL
shrink_factor
This value specifies the shrink factor.
Output:
 
 
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions:
 
This is only a partial list of the error values that can be returned by this function.
11000042
The display property list is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_shrfem_set (p. 245) in the PCL Reference Manual Examples.
 
ga_display_silhouette_get
(display_name, silhouette_status)
 
Description:
 
 
This function will get the value used to turn the display of silhouettes on and off for the named display property list.
Input:
 
 
STRING
display_name[31]
This value specifies the name of the display property list from which the requested data value will be obtained.
Output:
 
 
INTEGER
silhouette_status
This value returns the value of used to control the display of silhouettes. This argument can return any value.
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions:
 
This is only a partial list of the error values that can be returned by this function.
11000042
The display property list is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_silhouette_get (p. 247) in the PCL Reference Manual Examples.
 
ga_display_silhouette_set
(display_name, silhouette_status)
 
Description:
 
 
This function will set the value used to turn the display of silhouettes on and off for the named display property list.
Input:
 
 
STRING
display_name[31]
This value specifies the name of the display property list to which the requested data value will be set.
INTEGER
silhouette_status
This value specifies the status value used control the display of silhouettes. This argument can be set to any value.
Output:
 
 
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions:
 
This is only a partial list of the error values that can be returned by this function.
11000042
The display property list is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_silhouette_set (p. 248) in the PCL Reference Manual Examples.
  
ga_display_specular_get
(display_name, color_value)
 
Description:
 
 
This function will get the value used to control the color used for the shading of specular reflections for the named display property list.
Input:
 
 
STRING
display_name[31]
This value specifies the name of the display property list from which the requested data value will be obtained.
Output:
 
 
INTEGER
color_value
This value returns the value used to control the color used for the shading of specular reflections. This argument can have a value of 1, for the color of the light, or 2, for the color of the object.
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions:
 
This is only a partial list of the error values that can be returned by this function.
11000042
The display property list is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_specular_get (p. 250) in the PCL Reference Manual Examples.
 
ga_display_specular_set
(display_name, color_value)
 
Description:
 
 
This function will set the value used to control the color used for the shading of specular reflections for the named display property list.
Input:
 
 
STRING
display_name[31]
This value specifies the name of the display property list to which the requested data value will be set.
INTEGER
color_value
This value specifies the color used for the shading of specular reflections. This argument can be set to a value of 1, for the color of light, or 2, for the color of the object.
Output:
 
 
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions:
 
This is only a partial list of the error values that can be returned by this function.
11000042
The display property list is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_specular_set (p. 251) in the PCL Reference Manual Examples.
 
ga_display_subdivision_get
(display_name, tolerance)
 
Description:
 
 
This function will get the subdivision tolerance for the named display property list.
Input:
 
 
STRING
display_name[31]
This value specifies the name of the display property list from which the requested data value will be obtained.
Output:
 
 
REAL
tolerance
This value returns the subdivision tolerance.
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions:
 
This is only a partial list of the error values that can be returned by this function.
11000042
The display property list is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_subdivision_get (p. 252) in the PCL Reference Manual Examples.
  
ga_display_subdivision_set
(display_name, tolerance)
 
Description:
This function will set the subdivision tolerance for the named display property list.
Input:
STRING
display_name[31]
This value specifies the name of the display property list to which the requested data value will be set.
REAL
tolerance
This value specifies the subdivision tolerance value.
Output:
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000042
The display property list is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_subdivision_set (p. 254) in the PCL Reference Manual Examples.
 
ga_display_texture_get
(display_name, texture_value)
 
Description:
 
 
This function will get the texture value from the named display property list.
Input:
 
 
STRING
display_name[31]
This value specifies the name of the display property list from which the requested data value will be obtained.
Output:
 
 
REAL
texture_value
This value returns the texture value.
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions:
 
This is only a partial list of the error values that can be returned by this function.
11000042
The display property list is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_texture_get (p. 255) in the PCL Reference Manual Examples.
 
ga_display_texture_set
(display_name, texture_value)
 
Description:
 
 
This function will set the texture value for the named display property list.
Input:
 
 
STRING
display_name[31]
This value specifies the name of the display property list to which the requested data value will be set.
REAL
texture_value
This value specifies the texture value.
Output:
 
 
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions:
 
This is only a partial list of the error values that can be returned by this function.
11000042
The display property list is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_texture_set (p. 257) in the PCL Reference Manual Examples.
  
ga_display_transparency_get
(display_name, transparency_value)
 
Description:
 
 
This function will get the transparency level from the named display property list.
Input:
 
 
STRING
display_name[31]
This value specifies the name of the display property list from which the requested data value will be obtained.
Output:
 
 
REAL
transparency_value
This value returns the transparency level.
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions:
 
This is only a partial list of the error values that can be returned by this function.
11000042
The display property list is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_transparency_get (p. 258) in the PCL Reference Manual Examples.
 
ga_display_transparency_set
(display_name, transparency_value)
 
Description:
 
 
This function will set the transparency level for the named display property list.
Input:
 
 
STRING
display_name[31]
This value specifies the name of the display property list to which the requested data value will be set.
REAL
transparency_value
This value specifies the transparency value.
Output:
 
 
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions:
 
This is only a partial list of the error values that can be returned by this function.
11000042
The display property list is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_transparency_set (p. 259) in the PCL Reference Manual Examples.
  
ga_display_undeform_color_get
(display_name, color_value)
 
Description:
 
 
This function will get the value of the color for undeformed entities from the named display property list.
Input:
 
 
STRING
display_name[31]
This value specifies the name of the display property list from which the requested data value will be obtained.
Output:
 
 
INTEGER
color_value
This value returns the color value for undeformed entities.
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions:
 
This is only a partial list of the error values that can be returned by this function.
11000042
The display property list is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_undeform_color_get (p. 260) in the PCL Reference Manual Examples.
  
ga_display_undeform_color_set
(display_name, color_value)
 
Description:
This function will set the value of the color for undeforned entities for the named display property list.
Input:
STRING
display_name[31]
This value specifies the name of the display property list to which the requested data value will be set.
INTEGER
color_value
This value specifies the color used for the display of undeformed entities.
Output:
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000042
The display property list is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_undeform_color_set (p. 261) in the PCL Reference Manual Examples.
 
ga_display_undeform_get
(display_name, undeform_status)
 
Description:
 
 
This function will get the on/off status of the value used to control the display of undeformed entities from the named display property list.
Input:
 
 
STRING
display_name[31]
This value specifies the name of the display property list from which the requested data value will be obtained.
Output:
 
 
INTEGER
undeform_status
This value returns the status value used to control the display of undeformed entities. This argument can return any value.
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions:
 
This is only a partial list of the error values that can be returned by this function.
11000042
The display property list is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_undeform_get (p. 263) in the PCL Reference Manual Examples.
 
ga_display_undeform_set
(display_name, undeform_status)
 
Description:
This function will set the on/off status of the value used to control the display of undeformed entities for the named display property list.
Input:
STRING
display_name[31]
This value specifies the name of the display property list to which the requested data value will be set.
INTEGER
undeform_status
This value specifies the on/off status used to control the display of undeformed entities. The argument can be set to any value.
Output:
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000042
The display property list is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_undeform_set (p. 264) in the PCL Reference Manual Examples.
 
ga_display_undeform_style_get
(display_name, curve_style)
 
Description:
This function will get the value used to control the style used for the display of the lines that comprise undeformed entities from the named display property list.
Input:
STRING
display_name[31]
This value specifies the name of the display property list from which the requested data value will be obtained.
Output:
STRING
curve_style[31]
This value returns the style used to display the lines that comprise undeformed entities. This value will be set to either “SOLID”, or “DASHED”.
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000042
The display property list is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_undeform_style_get (p. 265) in the PCL Reference Manual Examples.
  
ga_display_undeform_style_set
(display_name, curve_style)
 
Description:
 
 
This function will set the value used to control the style used for the display of the lines that comprise undeformed entities for the named display property list.
Input:
 
 
STRING
display_name[31]
This value specifies the name of the display property list to which the requested data value will be set.
STRING
curve_style[31]
This value specifies the style used to display the lines that comprise undeformed entities. The values allowed for this string are “SOLID”, or “DASHED”. This argument is not case sensitive.
Output:
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions:
 
This is only a partial list of the error values that can be returned by this function.
11000042
The display property list is invalid.
11000090
The specified undeformed entity style is not valid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_undeform_style_set (p. 266) in the PCL Reference Manual Examples.
 
ga_display_vector_color_get
(display_name, color_value)
 
Description:
This function will get the value for the color used to plot vectors from the named display property list.
Input:
STRING
display_name[31]
This value specifies the name of the display property list from which the requested data value will be obtained.
Output:
INTEGER
color_value
This value returns the color used to plot vectors.
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000042
The display property list is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_vector_color_get (p. 267) in the PCL Reference Manual Examples.
  
ga_display_vector_color_set
(display_name, color_value)
 
Description:
 
 
This function will set the value of the color used to plot vectors for the named display property list.
Input:
 
 
STRING
display_name[31]
This value specifies the name of the display property list to which the requested data value will be set.
INTEGER
color_value
This value specifies the color used to plot vectors.
Output:
 
 
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions:
 
This is only a partial list of the error values that can be returned by this function.
11000042
The display property list is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_vector_color_set (p. 269) in the PCL Reference Manual Examples.
  
ga_display_vector_colorstyl_get
(display_name, vector_style)
 
Description:
 
 
This function will get the style used to plot vectors from the named display property list.
Input:
 
 
STRING
display_name[31]
This value specifies the name of the display property list from which the requested data value will be obtained.
Output:
 
 
STRING
vector_style[31]
This value returns the style used to plot vectors. This argument can return the values “VALUE”, “COMPONENT”, or “SPECTRUM”.
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions:
 
This is only a partial list of the error values that can be returned by this function.
11000042
The display property list is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_vector_colorstyl_get (p. 270) in the PCL Reference Manual Examples.
 
ga_display_vector_colorstyl_set
(display_name, vector_style)
 
Description:
 
 
This function will set the style used to plot vectors for the named display property list.
Input:
 
 
STRING
display_name[31]
This value specifies the name of the display property list to which the requested data value will be set.
STRING
vector_style[31]
This value specifies the style used to plot vectors. This argument can a value of “VALUE”, “COMPONENT”, or “SPECTRUM”.
Output:
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000042
The display property list is invalid.
11000094
Message 11000094 not found in message file(s).
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_vector_colorstyl_set (p. 271) in the PCL Reference Manual Examples.
  
ga_display_vector_facolor_get
(display_name, color_value)
 
Description:
This function will get the colors used to display functional assignment vectors from the named display property list.
Input:
STRING
display_name[31]
This value specifies the name of the display property list from which the requested data value will be obtained.
Output:
INTEGER
color_value(5)
This value returns the color values used to display functional assignment vectors.
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions:
 
This is only a partial list of the error values that can be returned by this function.
11000042
The display property list is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_vector_facolor_get (p. 272) in the PCL Reference Manual Examples.
 
ga_display_vector_facolor_set
(display_name, color_value)
 
Description:
This function will set the values used to display functional assignment vectors for the named display property list.
Input:
STRING
display_name[31]
This value specifies the name of the display property list to which the requested data value will be set.
INTEGER
color_value(5)
This value specifies the color values used to display functional assignment vectors.
Output:
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000042
The display property list is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_vector_facolor_set (p. 273) in the PCL Reference Manual Examples.
  
ga_display_vector_falabel_get
(display_name, label_status)
 
Description:
 
 
This function will get the on/off status value used to control the display of labels for functional assignment vectors from the named display property list.
Input:
STRING
display_name[31]
This value specifies the name of the display property list from which the requested data value will be obtained.
Output:
INTEGER
label_status
This value returns the on/off status for the display of functional assignment vector labels. This argument can return any value.
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000042
The display property list is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_vector_falabel_get (p. 274) in the PCL Reference Manual Examples.
 
ga_display_vector_falabel_set
(display_name, label_status)
 
Description:
This function will set the on/off status value used to control the display of labels for functional assignment vectors for the named display property list.
Input:
STRING
display_name[31]
This value specifies the name of the display property list to which the requested data value will be set.
INTEGER
label_status
This value specifies the on/off status for the display of function assignment vector labels. This argument can be set to any value.
Output:
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000042
The display property list is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_vector_falabel_set (p. 276) in the PCL Reference Manual Examples.
 
ga_display_vector_length_get
(display_name, vector_style)
 
Description:
This function will get the value used to control the length style of plotted vectors from the named display property list.
Input:
STRING
display_name[31]
This value specifies the name of the display property list from which the requested data value will be obtained.
Output:
STRING
vector_style[31]
This value returns the vector length style. This argument will return the value “CONSTANT/SCREEN”, “SCALED/SCREEN”, “CONSTANT/MODEL”, or “SCALED/MODEL”.
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000042
The display property list is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_vector_length_get (p. 277) in the PCL Reference Manual Examples.
 
ga_display_vector_length_set
(display_name, vector_style)
 
Description:
 
 
This function will set the value used to control the length style of plotted vectors for the named display property list.
Input:
 
 
STRING
display_name[31]
This value specifies the name of the display property list to which the requested data value will be set.
STRING
vector_style[31]
This value specifies the vector length style. This argument can be set to the value “CONSTANT/SCREEN”, “SCALED_SCREEN”, “CONSTANT/MODEL”, or “SCALED/MODEL”. The value of this argument is not case sensitive.
Output:
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000042
The display property list is invalid.
11000094
Message 11000094 not found in message file(s).
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_vector_length_set (p. 278) in the PCL Reference Manual Examples.
 
ga_display_vector_reslabel_get
(display_name, label_status)
 
Description:
This function will get the on/off status value used to control the display of labels on results vectors from the named display property list.
Input:
STRING
display_name[31]
This value specifies the name of the display property list from which the requested data value will be obtained.
Output:
INTEGER
label_status
This value returns the status value used to control the display of labels on results vectors. This argument can return any value.
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000042
The display property list is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_vector_reslabel_get (p. 279) in the PCL Reference Manual Examples.
  
ga_display_vector_reslabel_set
(display_name, label_status)
 
Description:
This function will set the on/off status value used to control the display of labels on results vectors for the named display property list.
Input:
STRING
display_name[31]
This value specifies the name of the display property list to which the requested data value will be set.
INTEGER
label_status
This value specifies the status of the value used to control the display of labels on results vectors. This argument can be set to any value.
Output:
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions:
 
This is only a partial list of the error values that can be returned by this function.
11000042
The display property list is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_vector_reslabel_set (p. 280) in the PCL Reference Manual Examples.
 
ga_display_vector_scale_get
(display_name, vector_scale)
 
Description:
This function will get the scale value used with vector plots from the named display property list.
Input:
STRING
display_name[31]
This value specifies the name of the display property list from which the requested data value will be obtained.
Output:
REAL
vector_scale
This value returns the scale value used with vector plots.
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000042
The display property list is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_vector_scale_get (p. 281) in the PCL Reference Manual Examples.
  
ga_display_vector_scale_set
(display_name, vector_scale)
 
Description:
This function will set the scale value used with vector plots for the named display property list.
Input:
STRING
display_name[31]
This value specifies the name of the display property list to which the requested data value will be set.
REAL
vector_scale
This value specifies the scale value used with vector plots.
Output:
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000042
The display property list is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_vector_scale_set (p. 283) in the PCL Reference Manual Examples.
 
ga_display_vector1_color_get
(display_name, color_value)
 
Description:
This function will get the first vector component color from the named display property list.
Input:
STRING
display_name[31]
This value specifies the name of the display property list from which the requested data value will be obtained.
Output:
INTEGER
color_value
This value returns the color value for the first vector component.
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000042
The display property list is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_vector1_color_get (p. 284) in the PCL Reference Manual Examples.
  
ga_display_vector1_color_set
(display_name, color_value)
 
Description:
This function will set the first vector component color for the named display property list.
Input:
STRING
display_name[31]
This value specifies the name of the display property list to which the requested data value will be set.
INTEGER
color_value
This value specifies the color value for the first vector component.
Output:
 
 
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions:
 
This is only a partial list of the error values that can be returned by this function.
11000042
The display property list is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_vector1_color_set (p. 285) in the PCL Reference Manual Examples.
 
ga_display_vector2_color_get
(display_name, color_value)
 
Description:
This function will get the second vector component color from the named display property list.
Input:
STRING
display_name[31]
This value specifies the name of the display property list from which the requested data value will be obtained.
Output:
INTEGER
color_value
This value returns the color value for the second vector component.
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000042
The display property list is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_vector2_color_get (p. 287) in the PCL Reference Manual Examples.
 
ga_display_vector2_color_set
(display_name, color_value)
 
Description:
This function will set the second vector component color for the named display property list.
Input:
STRING
display_name[31]
This value specifies the name of the display property list to which the requested data value will be set.
INTEGER
color_value
This value specifies the color value for the second vector component.
Output:
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000042
The display property list is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_vector2_color_set (p. 288) in the PCL Reference Manual Examples.
 
ga_display_vector3_color_get
(display_name, color_value)
 
Description:
This function will get the third vector component color from the named display property list.
Input:
STRING
display_name[31]
This value specifies the name of the display property list from which the requested data value will be obtained.
Output:
INTEGER
color_value
This value returns the color value for the third vector component.
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000042
The display property list is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_vector3_color_get (p. 289) in the PCL Reference Manual Examples.
 
ga_display_vector3_color_set
(display_name, color_value)
 
Description:
This function will set the third vector component color for the named display property list.
Input:
STRING
display_name[31]
This value specifies the name of the display property list to which the requested data value will be set.
INTEGER
color_value
This value specifies the color value for the third vector component.
Output:
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000042
The display property list is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_vector3_color_set (p. 291) in the PCL Reference Manual Examples.