ga_viewport_axis_get | (viewport_name, axis_display) |
Description: | ||
This function will return a value from the database indicating if a coordinate axis should be displayed in a viewport. | ||
Input: | ||
STRING | viewport_name[31] | This value specifies the name of the viewport. |
Output: | ||
INTEGER | axis_display | This value returns the status of the coordinate axis display in the viewport. It will be set to TRUE or 1 if the coordinate axis should be displayed and FALSE or 0 if it should not. |
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. | ||
11000007 | The viewport name is invalid. | |
11000096 | A current viewport has not been defined. | |
11000098 | A fatal error has occurred in the database. Database is corrupted. | |
13000004 | GaErrDuplicate entry exists in table | |
13000007 | An unspecified database error occurred | |
13000014 | Viewport not found |
ga_viewport_axis_set | (viewport_name, axis_display) |
Description: | ||
This function will set a value in the database used to indicate if a coordinate axis display should be shown in the viewport. | ||
Input: | ||
STRING | viewport_name[31] | This value specifies the name of the viewport. |
INTEGER | axis_display | This value should be set to TRUE or 1 if the coordinate axis should be displayed and FALSE or 0 if it should not. |
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. | ||
11000007 | The viewport name is invalid. | |
11000096 | A current viewport has not been defined. | |
11000098 | A fatal error has occurred in the database. Database is corrupted. | |
13000004 | GaErrDuplicate entry exists in table | |
13000007 | An unspecified database error occurred | |
13000014 | Viewport not found |
ga_viewport_background_get | (viewport_name, background_color) |
Description: | ||
This function will get the background color of a viewport. | ||
Input: | ||
STRING | viewport_name[31] | This value specifies the name of the viewport. |
Output: | ||
INTEGER | background_color | This value returns the background color for the viewport. |
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. | ||
11000007 | The viewport name is invalid. | |
11000096 | A current viewport has not been defined. | |
11000098 | A fatal error has occurred in the database. Database is corrupted. | |
11000100 | The specified viewport was not found in the database. | |
13000004 | GaErrDuplicate entry exists in table | |
13000007 | An unspecified database error occurred | |
13000014 | Viewport not found |
ga_viewport_background_set | (viewport_name, background_color) |
Description: | ||
This function will set and post the background color of a viewport. | ||
Input: | ||
STRING | viewport_name[31] | This value specifies the name of the viewport. |
INTEGER | background_color | This value specifies the background color for the viewport. |
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. | ||
11000007 | The viewport name is invalid. | |
11000096 | A current viewport has not been defined. | |
11000098 | A fatal error has occurred in the database. Database is corrupted. | |
11000100 | The specified viewport was not found in the database. | |
13000004 | GaErrDuplicate entry exists in table | |
13000007 | An unspecified database error occurred | |
13000014 | Viewport not found |
ga_viewport_create | (viewport_name, x_location, y_location, width, height) |
Description: | ||
This function will create, set the active group to the current group, make current, and post a viewport. | ||
Input: | ||
STRING | viewport_name[31] | This value specifies the name of the viewport. |
REAL | x_location | This value specifies the X axis location of the upper left corner of the viewport relative to the upper left corner of the screen. |
REAL | y_location | This value specifies the Y axis location of the upper left corner of the viewport relative to the upper left corner of the screen. |
REAL | width | This value specifies the width of the viewport. |
REAL | height | This value specifies the height of the viewport. |
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. | ||
11000006 | A viewport with the given name is already in the database. | |
11000007 | The viewport name is invalid. | |
11000008 | The location of the viewport is out of range | |
11000009 | The size of the viewport is out of range | |
11000097 | There is not enough disk space to complete operation. | |
11000098 | A fatal error has occurred in the database. Database is corrupted. | |
11000100 | The specified viewport was not found in the database. | |
13000004 | Duplicate entry exists in table | |
13000007 | An unspecified database error occurred | |
13000013 | View not found |
ga_viewport_current_get | (viewport_name) |
Description: | ||
This function will get the name of the current viewport. | ||
Input: | ||
None. | ||
Output: | ||
STRING | viewport_name[31] | This value returns the name of the current viewport. |
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. | ||
11000007 | The viewport name is invalid. | |
11000096 | A current viewport has not been defined. | |
11000098 | A fatal error has occurred in the database. Database is corrupted. | |
13000004 | Duplicate entry exists in table | |
13000007 | An unspecified database error occurred | |
13000014 | Viewport not found |
ga_viewport_current_set | (viewport_name) |
Description: | ||
This function will set the name of the current viewport. | ||
Input: | ||
STRING | viewport_name[31] | This value specifies the name of the current viewport. |
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. | ||
11000007 | The viewport name is invalid. | |
13000004 | Duplicate entry exists in table | |
13000007 | An unspecified database error occurred |
ga_viewport_delete | (viewport_name) |
Description: | ||
This function deletes the named viewport. | ||
Input: | ||
STRING | viewport_name[31] | This value specify the name of the viewport to be deleted. |
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. | ||
11000007 | The viewport name is invalid. | |
11000095 | The specified operation cannot be performed on the current viewport. | |
11000098 | A fatal error has occurred in the database. Database is corrupted. | |
11000100 | The specified viewport was not found in the database. | |
13000004 | Duplicate entry exists in table | |
13000007 | An unspecified database error occurred |
ga_viewport_exist_get | (viewport_name, existance_flag) |
Description: | ||
This function can be used to find out if a viewport with a specified name exists. | ||
Input: | ||
STRING | viewport_name[31] | This value specifies the name of the viewport to be checked for existence. |
Output: | ||
INTEGER | existance_flag | This value returns TRUE or 1 if the named viewport exists, and FALSE or 0 if it does not. |
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. | ||
11000007 | The viewport name is invalid. | |
11000095 | The specified operation cannot be performed on the current viewport. | |
11000098 | A fatal error has occurred in the database. Database is corrupted. | |
11000100 | The specified viewport was not found in the database. | |
13000004 | Duplicate entry exists in table | |
13000007 | An unspecified database error occurred |
ga_viewport_group_post | (viewport_name, group_name) |
Description: | ||
This function posts a group to a viewport. | ||
Input: | ||
STRING | viewport_name[31] | This value specifies the name of the viewport to which the group will be posted. If this value is set to nothing or ““, the current viewport will be used. |
STRING | group_name[31] | This value specifies the name of the group to be posted. If this value is set to nothing or ““, the current viewport will be used. |
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. | ||
11000007 | The viewport name is invalid. | |
11000050 | The group name is invalid. | |
11000096 | A current viewport has not been defined. | |
11000098 | A fatal error has occurred in the database. Database is corrupted. | |
11000105 | The specified group was not found in the database. | |
11000121 | There is not a current group defined. | |
11000122 | The group has already been posted to the viewport. | |
13000004 | Duplicate entry exists in table | |
13000007 | An unspecified database error occurred | |
13000008 | Group not found | |
13000014 | Viewport not found |
ga_viewport_group_post_all | (viewport_name) |
Description: | ||
This function posts all defined groups to a viewport. | ||
Input: | ||
STRING | viewport_name[31] | This value specifies the name of the viewport to which the group will be posted. If this value is set to nothing or ““, the current viewport will be used. |
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. | ||
11000007 | The viewport name is invalid. | |
11000098 | A fatal error has occurred in the database. Database is corrupted. | |
11000100 | The specified viewport was not found in the database. | |
11000105 | The specified group was not found in the database. | |
11000122 | The group has already been posted to the viewport. | |
13000004 | Duplicate entry exists in table | |
13000007 | An unspecified database error occurred | |
13000008 | Group not found |
ga_viewport_group_unpost | (viewport_name, group_name) |
Description: | ||
This function unposts a group from a viewport. | ||
Input: | ||
STRING | viewport_name[31] | This value specifies the name of the viewport to which the group will be posted. If this value is set to nothing or ““, the current viewport will be used. |
STRING | group_name[31] | This value specifies the name of the group to be unposted. If this value is set to nothing or ““, the current viewport will be used. |
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. | ||
11000007 | The viewport name is invalid. | |
11000050 | The group name is invalid. | |
11000096 | A current viewport has not been defined. | |
11000098 | A fatal error has occurred in the database. Database is corrupted. | |
11000100 | The specified viewport was not found in the database. | |
11000105 | The specified group was not found in the database. | |
11000121 | There is not a current group defined. | |
11000122 | The group has already been posted to the viewport. | |
11000124 | Group cannot be unposted from viewport not posted to. | |
13000004 | Duplicate entry exists in table | |
13000007 | An unspecified database error occurred | |
13000008 | Group not found | |
13000014 | Viewport not found |
ga_viewport_group_unpost_all | (viewport_name) |
Description: | ||
This function will unpost all posted groups from a viewport. | ||
Input: | ||
STRING | viewport_name[31] | This value specifies the name of the viewport to which the group will be unposted. If this value is set to nothing or ““, the current viewport will be used. |
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. | ||
11000007 | The viewport name is invalid. | |
11000096 | A current viewport has not been defined. | |
11000100 | The specified viewport was not found in the database. | |
11000105 | The specified group was not found in the database. | |
11000125 | The viewport has no groups posted to it. | |
13000004 | Duplicate entry exists in table | |
13000007 | An unspecified database error occurred | |
13000008 | Group not found |
ga_viewport_groups_get | (viewport_name, group_list) |
Description: | ||
This function gets the groups posted to a viewport. | ||
Input: | ||
STRING | viewport_name[31] | This value specifies the name of the viewport from which the group list will be made. If this value is set to nothing or ““, the current viewport will be used. |
Output: | ||
STRING | group_list[31]() | This value returns a list of group names posted to the viewport. The number of offsets allocated for this array should match the number of groups posted to this viewport. 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. | ||
11000007 | The viewport name is invalid. | |
11000096 | A current viewport has not been defined. | |
11000098 | A fatal error has occurred in the database. Database is corrupted. | |
11000100 | The specified viewport was not found in the database. | |
11000114 | There are no groups posted to the viewport. | |
13000004 | Duplicate entry exists in table | |
13000007 | An unspecified database error occurred | |
13000008 | Group not found | |
13000085 | Cursor not open |
ga_viewport_light_post | (viewport_name, light) |
Description: | ||
This function posts a light source to a viewport. | ||
Input: | ||
STRING | viewport_name[31] | This value specifies the name of the viewport to which the light source will be posted. If this value is set to nothing or ““, the current viewport will be used. |
STRING | light[31] | This value specifies the name of a light source. |
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. | ||
11000007 | The viewport name is invalid. | |
11000036 | A light source with the given name is already in the database. | |
11000096 | A current viewport has not been defined. | |
11000098 | A fatal error has occurred in the database. Database is corrupted. | |
11000104 | The specified light source was not found in the database. | |
13000010 | Light source not found | |
13000014 | Viewport not found |
ga_viewport_light_unpost | (name, light) |
Description: | ||
This function unposts a light source from a viewport. | ||
Input: | ||
STRING | viewport_name[31] | This value specifies the name of the viewport to which the light source will be unposted. If this value is set to nothing or ““, the current viewport will be used. |
STRING | light[31] | This value specifies the name of a light source. |
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. | ||
11000007 | The viewport name is invalid. | |
11000036 | A light source with the given name is already in the database. | |
11000096 | A current viewport has not been defined. | |
11000098 | A fatal error has occurred in the database. Database is corrupted. | |
11000104 | The specified light source was not found in the database. | |
13000010 | Light source not found | |
13000014 | Viewport not found |
ga_viewport_lights_get | (viewport_name, light_list) |
Description: | ||
This function gets a list of light source names posted to a viewport. | ||
Input: | ||
STRING | viewport_name[31] | This value specifies the name of the viewport from which the list of light sources will be made. If this value is set to nothing or ““, the current viewport will be used. |
Output: | ||
STRING | light_list[31]() | This value returns a list of light source names posted to the viewport. The number of offsets allocated for this array should match the number of light sources posted to this viewport. 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. | |
11000100 | The specified viewport was not found in the database. | |
11000113 | There are no light sources posted to the viewport. | |
13000014 | Viewport not found |
ga_viewport_location_get | (viewport_name, x, y) |
Description: | ||
This function gets the viewport location relative to the upper left corner of the parent graphics window. | ||
Input: | ||
STRING | viewport_name[31] | This value specifies the name of the viewport from which the location will be retrieved. If this value is set to nothing or ““, the current viewport will be used. |
Output: | ||
REAL | x | This value returns the viewport X position. |
REAL | y | This value returns the viewport Y position. |
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. | ||
11000007 | The viewport name is invalid. | |
11000098 | A fatal error has occurred in the database. Database is corrupted. | |
11000100 | The specified viewport was not found in the database. | |
13000014 | Viewport not found |
ga_viewport_location_set | (viewport_name, x, y, update_control) |
Description: | ||
This function sets and optionally posts the viewport location relative to the upper left corner of the parent graphics window. | ||
Input: | ||
STRING | viewport_name[31] | This value specifies the name of the viewport that will have its location set. If this value is set to nothing or ““, the current viewport will be used. |
REAL | x | This value specifies the viewport X position and it must be a positive number. |
REAL | y | This value specifies the viewport Y position and it must be a positive number. |
INTEGER | update_control | This value specifies the method used to update or post the display with the new location information. When this value is set to 1 or TRUE, the viewport will be updated immediately. If the this value is set to 0 or FALSE, updating the viewport will be deferred until another graphics manager event takes place. It is recommended that this value always be set to 1 or TRUE. |
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. | ||
11000007 | The viewport name is invalid. | |
11000008 | The location of the viewport is out of range | |
11000096 | A current viewport has not been defined. | |
11000098 | A fatal error has occurred in the database. Database is corrupted. | |
11000100 | The specified viewport was not found in the database. |
ga_viewport_ngroups_get | (viewport_name, number_of_groups) |
Description: | ||
This function will get the number of groups posted to a viewport. | ||
Input: | ||
STRING | viewport_name[31] | This value specifies the name of the viewport from which the number of groups assigned to the viewport will be obtained. If this value is set to nothing or ““, the current viewport will be used. |
Output: | ||
INTEGER | number_of_groups | This value returns the number of groups assigned to a viewport. |
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. | ||
11000007 | The viewport name is invalid. | |
11000096 | A current viewport has not been defined. | |
11000100 | The specified viewport was not found in the database. | |
11000098 | A fatal error has occurred in the database. Database is corrupted. |
ga_viewport_nlights_get | (viewport_name, number_of_lights) |
Description: | ||
This function will get the number of lights posted to a viewport. | ||
Input: | ||
STRING | viewport_name[31] | This value specifies the name of the viewport from which the number of light sources assigned to the viewport will be obtained. If this value is set to nothing or ““, the current viewport will be used. |
Output: | ||
INTEGER | number_of_lights | This value returns the number of light sources assigned to a viewport. |
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. | ||
11000007 | The viewport name is invalid. | |
11000096 | A current viewport has not been defined. | |
11000098 | A fatal error has occurred in the database. Database is corrupted. | |
11000100 | The specified viewport was not found in the database. |
ga_viewport_nposted_get | (number_of_viewports) |
Description: | ||
This function will get the number of viewports that have been marked as posted. | ||
Input: | ||
None. | ||
Output: | ||
INTEGER | number_of_viewports | This value returns the number of posted viewports. |
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. |
ga_viewport_nviewports_get | (number_of_viewports) |
Description: | ||
This function will get the number of viewports that have been defined in the database. | ||
Input: | ||
None. | ||
Output: | ||
INTEGER | number_of_viewports | This value returns the number of viewports. |
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. |
ga_viewport_origin_get | (viewport_name, origin_status) |
Description: | ||
This function will get the status of a value used to state if a symbol should be displayed at the origin of the global coordinate system for a viewport. | ||
Input: | ||
STRING | viewport_name[31] | This value specifies the name of the viewport that will be checked for the state of the origin symbol. If this value is set to nothing or ““, the current viewport will be used. |
Output: | ||
INTEGER | origin_status | This value returns the status value used to indicate if a coordinate system origin symbol should be displayed. This value will be set to 1 or TRUE if the coordinate system origin should be displayed, 0 or FALSE if it should not be displayed. |
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. | ||
11000007 | The viewport name is invalid. | |
11000096 | A current viewport has not been defined. | |
11000098 | A fatal error has occurred in the database. Database is corrupted. | |
11000100 | The specified viewport was not found in the database. | |
13000014 | Viewport not found |
ga_viewport_origin_set | (viewport_name, origin_status) |
Description: | ||
This function will set and post the status of a value used to state if a symbol should be displayed at the origin of the global coordinate system for a viewport. | ||
Input: | ||
STRING | viewport_name[31] | This value specifies the name of the viewport that will have its coordinate system origin state set. If this value is set to nothing or ““, the current viewport will be used. |
INTEGER | origin_status | This value specifies the status value used to indicate if a coordinate system origin symbol should be displayed. This value should be set to either 1 or TRUE if the coordinate system origin should be displayed, or 0 or FALSE if it should not. |
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. | ||
11000007 | The viewport name is invalid. | |
11000096 | A current viewport has not been defined. | |
11000098 | A fatal error has occurred in the database. Database is corrupted. | |
11000100 | The specified viewport was not found in the database. | |
13000014 | Viewport not found |
ga_viewport_post | (viewport_name) |
Description: | ||
This function will post a viewport. | ||
Input: | ||
STRING | viewport_name[31] | This value specifies the name of the viewport that will have its coordinate system origin state set. If this value is set to nothing or ““, the current viewport will be used. |
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. | ||
11000007 | The viewport name is invalid. | |
11000096 | A current viewport has not been defined. | |
11000098 | A fatal error has occurred in the database. Database is corrupted. | |
11000100 | The specified viewport was not found in the database. | |
13000014 | Viewport not found |
ga_viewport_posted_get | (viewport_list) |
Description: | ||
This function will get a list of all of the posted viewports. | ||
Input: | ||
None. | ||
Output: | ||
STRING | viewport_list[31]() | This value returns a list of all of the posted viewports. The number of offsets allocated for this array should match the number of posted viewports. 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. | |
11000100 | The specified viewport was not found in the database. |
ga_viewport_range_get | (viewport_name, range) |
Description: | ||
This function will get the name of the range of numeric values used in conjunction with spectrums for displaying results posted to a viewport. | ||
Input: | ||
STRING | viewport_name[31] | This value specifies the name of the viewport from which the range assigned to the viewport will be obtained. If this value is set to nothing or ““, the current viewport will be used. |
Output: | ||
STRING | range[31] | This value returns the name of the range posted to the specified viewport. |
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. | ||
11000007 | The viewport name is invalid. | |
11000096 | A current viewport has not been defined. | |
11000098 | A fatal error has occurred in the database. Database is corrupted. | |
11000100 | The specified viewport was not found in the database. |
ga_viewport_range_set | (viewport_name, range) |
Description: | ||
This function will set and post the name of the range of numeric values used in conjunction with spectrums for displaying results to a viewport. | ||
Input: | ||
STRING | viewport_name[31] | This value specifies the name of the viewport from which the range assigned to the viewport will be obtained. If this value is set to nothing or ““, the current viewport will be used. |
STRING | range[31] | This value specifies the name of the range that will be set and posted to the viewport. If this value is set to nothing or ““, the current range will be used. |
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. | ||
11000007 | The viewport name is invalid. | |
11000096 | A current viewport has not been defined. | |
11000098 | A fatal error has occurred in the database. Database is corrupted. | |
11000100 | The specified viewport was not found in the database. |
ga_viewport_rename | (original_name, new_name) |
Description: | ||
This function will rename a viewport. | ||
Input: | ||
STRING | original_name[31] | This value specifies the original name of the viewport. Setting this value to nothing or ““to identify the current viewport does not work here and will generate an error. |
STRING | new_name[31] | This value specifies the new viewport name. |
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. | ||
11000007 | The viewport name is invalid. | |
11000098 | A fatal error has occurred in the database. Database is corrupted. | |
11000100 | The specified viewport was not found in the database. |
ga_viewport_size_get | (viewport_name, width, height) |
Description: | ||
This function gets the width and height of a viewport. | ||
Input: | ||
STRING | viewport_name[31] | This value specifies the name of the viewport from which the height and width will be obtained. If this value is set to nothing or ““, the current viewport will be used. |
Output: | ||
REAL | width | This value returns the viewport width. |
REAL | height | This value returns the viewport height. |
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. | ||
11000007 | The viewport name is invalid. | |
11000098 | A fatal error has occurred in the database. Database is corrupted. | |
11000100 | The specified viewport was not found in the database. |
ga_viewport_size_set | (viewport_name, width, height, update_control) |
Description: | ||
This function sets the width and height of a viewport. | ||
Input: | ||
STRING | viewport_name[31] | This value specifies the name of the viewport from which the height and width will be obtained. If this value is set to nothing or ““, the current viewport will be used. |
REAL | width | This value specifies the width of the viewport and must be greater than or equal to 1.0. |
REAL | height | This value specifies the height of the viewport and must be greater than or equal to 1.0. |
INTEGER | update_control | This value specifies the method used to update or post the display with the new size information. When this value is set to 1 or TRUE, the viewport will be updated immediately. If the this value is set to 0 or FALSE, updating the viewport will be deferred until another graphics manager event takes place. It is recommended that this value always be set to 1 or TRUE. |
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. | ||
11000007 | The viewport name is invalid. | |
11000009 | The size of the viewport is out of range. | |
11000098 | A fatal error has occurred in the database. Database is corrupted. | |
11000100 | The specified viewport was not found in the database. |
ga_viewport_spectrum_get | (viewport_name, spectrum_status) |
Description: | ||
This function gets the current value of an integer intended to be used to record the posting status of the current spectrum for a viewport. | ||
Input: | ||
STRING | viewport_name[31] | This value specifies the name of the viewport from which the posting status of the current spectrum will be obtained. If this value is set to nothing or ““, the current viewport will be used. |
Output: | ||
INTEGER | spectrum_status | This value returns the status of the integer intended for use in recording the posting status of the current spectrum to a viewport. |
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. | ||
11000007 | The viewport name is invalid. | |
11000096 | A current viewport has not been defined. | |
11000098 | A fatal error has occurred in the database. Database is corrupted. | |
11000100 | The specified viewport was not found in the database. |
ga_viewport_spectrum_set | (viewport_name, spectrum_status) |
Description: | ||
This function is used to set the value of an integer intended to be used to record the posting status of the current spectrum for a viewport. | ||
Input: | ||
STRING | viewport_name[31] | This value specifies the name of the viewport to which the posting status of the current spectrum will be set. If this value is set to nothing or ““, the current viewport will be used. |
INTEGER | spectrum_status | This value specifies the status of the integer intended for use in recording the posting status of the current spectrum to a viewport. |
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. | ||
11000007 | The viewport name is invalid. | |
11000096 | A current viewport has not been defined. | |
11000098 | A fatal error has occurred in the database. Database is corrupted. | |
11000100 | The specified viewport was not found in the database. |
ga_viewport_title_post | (viewport_name, title) |
Description: | ||
This function will post a title to a viewport. | ||
Input: | ||
STRING | viewport_name[31] | This value specifies the name of the viewport from which the title will be posted. If this value is set to nothing or ““, the current viewport will be used. |
STRING | title[256] | This value specifies the title that will be posted to the viewport. |
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. | ||
11000007 | The viewport name is invalid. | |
11000096 | A current viewport has not been defined. | |
11000098 | A fatal error has occurred in the database. Database is corrupted. | |
13000004 | Duplicate entry exists in table | |
13000014 | Viewport not found | |
13000135 | The specified VP title was not found. |
ga_viewport_title_unpost | (viewport_name, title) |
Description: | ||
This function will unpost a title from a viewport and delete the title from the database. | ||
Input: | ||
STRING | viewport_name[31] | This value specifies the name of the viewport from which the title will be unposted. If this value is set to nothing or ““, the current viewport will be used. |
STRING | title[256] | This value specifies the title that will be unposted from the viewport. |
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. | ||
11000007 | The viewport name is invalid. | |
11000096 | A current viewport has not been defined. | |
11000098 | A fatal error has occurred in the database. Database is corrupted. | |
13000014 | Viewport not found | |
13000135 | The specified VP title was not found. |
ga_viewport_unpost | (viewport_name) |
Description: | ||
This function will unpost a viewport. | ||
Input: | ||
STRING | viewport_name[31] | This value specifies the name of the viewport that will be marked as unposted. If this value is set to nothing or ““, the current viewport will be used. |
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. | ||
11000007 | The viewport name is invalid. | |
11000096 | A current viewport has not been defined. | |
11000098 | A fatal error has occurred in the database. Database is corrupted. | |
11000100 | The specified viewport was not found in the database. |
ga_viewport_view_get | (name_of_view, viewport_name) |
Description: | ||
This function will assign a view name to the current view parameters of a viewport. | ||
Input: | ||
STRING | viewport_name[31] | This value specifies the name of the viewport from which the current view parameters will be obtained. If this value is set to nothing or ““, the current viewport will be used. |
STRING | name_of_view[31] | This value specifies the name of the view to which the current view parameters of the viewport will be assigned. |
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. | ||
11000007 | The viewport name is invalid. | |
11000058 | The view name is invalid. | |
11000098 | A fatal error has occurred in the database. Database is corrupted. | |
11000100 | The specified viewport was not found in the database. | |
11000103 | The specified view was not found in the data base. |
ga_viewport_view_name | (viewport_name, name_of_view) |
Description: | ||
This function will get the name of the view of a viewport. | ||
Input: | ||
STRING | viewport_name[31] | This value specifies the name of the viewport from which the name of the view will be obtained. If this value is set to nothing or ““, the current viewport will be used. |
Output: | ||
STRING | name_of_view[31] | This value returns the name of the view for the specified viewport. |
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. | ||
11000007 | The viewport name is invalid. | |
11000096 | A current viewport has not been defined. | |
11000098 | A fatal error has occurred in the database. Database is corrupted. | |
11000100 | The specified viewport was not found in the database. | |
11000116 | No view has been assigned to the viewport. |
ga_viewport_view_set | (name_of_view, viewport_name) |
Description: | ||
This function will post a view to a viewport. | ||
Input: | ||
STRING | viewport_name[31] | This value specifies the name of the viewport to which the view will be posted. If this value is set to nothing or ““, the current viewport will be used. |
STRING | name_of_view[31] | This value specifies the name of the view that will be posted to the viewport. If this value is set to nothing or ““, the current view will be used. |
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. | ||
11000007 | The viewport name is invalid. | |
11000058 | The view name is invalid. | |
11000098 | A fatal error has occurred in the database. Database is corrupted. | |
11000100 | The specified viewport was not found in the database. | |
11000103 | The specified view was not found in the data base. | |
13000004 | Duplicate entry exists in table | |
13000007 | An unspecified database error occurred | |
13000013 | View not found |
ga_viewport_viewports_get | (viewport_list) |
Description: | ||
This function gets a list of all of the viewports, including viewports that have not been posted. | ||
Input: | ||
None. | ||
Output: | ||
STRING | viewport_list[31]() | This value returns a list of all of the viewports. The number of offsets allocated for this array should match the number of viewports. 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. |