GXSYS class

class geosoft.gxapi.GXSYS
The SYS library functions perform a wide range functions,
including the storage and retrieval of named parameters
from the current workspace; writing messages to the user;
display of progress bars; retrieving file, date and time
information from the operating system; and providing warning
and error handling functions.

Note:

PARAMETER CONTROL FUNCTIONS

Parameters can be named with an index extension.
For example, a parameter could be named as "PARM[1]".
The index can be a positive number, or it can be a '*'.

If the index is a '*' in "geosoft.gxapi.GXSYS.set_string()", then the value string
will be parsed into multiple values. Commas are assumed to be delimiters.

E.g.

geosoft.gxapi.GXSYS.set_string()("group1",
"multiparm[*]",
"value1,"value,2","value 3",  value4  ,"value 5 "");

This call will set   multiparm[0] ="value1"
multiparm[1] ="value,2"
multiparm[2] ="value 3"
multiparm[3] ="value4"
multiparm[4] ="value 5"

To read a parameter, name the parameter with the index.  Thre is no
looped-reading ability.  For example:

GetString_SYS("group1","multiparm[3]",sSetting);

returns sSetting = "value4"
static abort((str)arg1) → None:
This method terminates the execution of a script. A message
giving the reason for the abort will be displayed along with
the line number where we stopped in the script.
Parameters:arg1 (str) – Message to display
Returns:Nothing
Return type:None

New in version 5.0.0.

static absolute_file_name((str)arg1, (str_ref)arg2) → None:
Convert an abbreviated path name to a full path name.
Parameters:
  • arg1 (str) – Input file name to resolve
  • arg2 (geosoft.gxapi.str_ref) – Output name, can be the same as input
Returns:

Nothing
Return type:

None

New in version 5.0.0.

Note:

This is mainly intended to convert ".name" to a full
name at run-time.
static add_lineage_parameter((str)arg1, (str)arg2) → None:
Add a parameter to the current lineage object
Parameters:
  • arg1 (str) – Paramter Name
  • arg2 (str) – Parameter Value
Returns:

Nothing
Return type:

None

New in version 7.0.0.

static add_lineage_source((int)arg1, (str)arg2) → None:
Add a source to the current lineage object
Parameters:
Returns:

Nothing
Return type:

None

New in version 7.0.0.

static assert((int)arg1) → None:
Abort with GX line number if not true.
Parameters:arg1 (int) – Expression to evaluate (0 aborts)
Returns:Nothing
Return type:None

New in version 5.0.0.

static assert_gx((int)arg1, (str)arg2, (str)arg3) → int:
DLL function argument error assertion
Parameters:
  • arg1 (int) – boolean expression (ie. (dB != 0.0) )
  • arg2 (str) – module name
  • arg3 (str) – argument name
Returns:

0 assertion passed 1 assertion failed
Return type:

int

New in version 5.0.0.

Note:

Use this function to evaluate errors in passed
function arguments.  Functions called by GX programs
should be tolerant of all errors in the passed argument
list.  The geosoft.gxapi.GXSYS.assert_gx() can be used to test each
argument before doing any work in the function.  If
an assertion fails, an error will be registered with
the name of the function and the parameter name and
a 1 will be returned.  The caller should immediatley
cleaning up (if necessary) and return.

You could also test the validity of arguments and call
the geosoft.gxapi.GXSYS.error(), geosoft.gxapi.GXSYS.error_tag() and geosoft.gxapi.GXSYS.terminate()
functions if you would like to provide a more specific
error message.
static backup_geo_file((str)arg1, (str_ref)arg2) → None:
Backup a Geosoft data file and all associated files to a temporary folder.
Parameters:
Returns:

Nothing
Return type:

None

New in version 7.0.0.

Note:

Grids are copied and the GI's are maintained - note that support
for non-geosoft grids is limited since this method does not
guarantee all grid files besides the main one are copied.
static break_date((float)arg1, (int_ref)arg2, (int_ref)arg3, (int_ref)arg4) → None:
Breaks a decimal date value into year, month and day.
Parameters:
Returns:

Nothing
Return type:

None

New in version 5.1.1.

static cancel() → None:
This method indicates that the GX program terminated without
doing anything of interest and should be ignored.  In
particular, the GX will not be logged in a recorded GS.
Returns:Nothing
Return type:None

New in version 5.0.0.

static check_arc_license() → int:
Check to see if a ESRI ArcEngine or ArcView license is available
Returns:1 - Licenced 0 - Not licenced
Return type:int

New in version 7.1.0.

static check_arc_license_ex((str_ref)arg1) → int:
Check to see if a ESRI ArcEngine or ArcView license is available, returns type and version of available engine.
Parameters:arg1 (geosoft.gxapi.str_ref) – Version String
Returns:ARC_LICENSE constants
Return type:int

New in version 9.0.0.

static check_intrinsic((int)arg1, (str)arg2) → int:
Check to see if an intrinsic object is licensed
Parameters:
  • arg1 (int) – Intrinsic Class Number
  • arg2 (str) – Intrinsic Name (must be exact)
Returns:

1 - Licenced 0 - Not licenced
Return type:

int

New in version 6.0.0.

static check_stop() → int:
This method is called at convenient points in the
GX code to check if the user has asked the script
to stop running. This method should be called by
any GX program that may take a while to complete.
Returns:0 - No 1 - Yes, Terminate processing.
Return type:int

New in version 5.0.0.

static clear_err_ap() → int:
This method is called at to clear all registered errors.
Returns:0 - Successful
Return type:int

New in version 5.1.1.

static clear_group((str)arg1) → None:
Clear current contents of a group
Parameters:arg1 (str) – group to clear
Returns:Nothing
Return type:None

New in version 5.0.0.

static clear_group_parm((str)arg1) → None:
Clears all paramters in a specified group.
Parameters:arg1 (str) – string
Returns:Nothing
Return type:None

New in version 5.1.1.

static clear_lineage_parameters() → None:
Clear all the lineage parameters
Returns:Nothing
Return type:None

New in version 7.0.0.

static clear_lineage_sources() → None:
Clear all the lineage sources
Returns:Nothing
Return type:None

New in version 7.0.0.

static clear_menus((int)arg1) → None:
Clear all menus
Parameters:arg1 (int) – SYS_MENU_CLEAR constants
Returns:Nothing
Return type:None

New in version 5.0.0.

static clear_parm() → None:
Clears all paramters.
Returns:Nothing
Return type:None

New in version 5.0.0.

static clipboard_to_file((str)arg1) → None:
Copy text from the clipboard to a file.
Parameters:arg1 (str) – File name to place it into
Returns:Nothing
Return type:None

New in version 5.0.0.

static copy_file((str)arg1, (str)arg2) → int:
Copy a file.
Parameters:
  • arg1 (str) – source file
  • arg2 (str) – destination file
Returns:

0 if file copied ok. 1 if unable to copy file or source file not found.
Return type:

int

New in version 5.1.8.

static copy_geo_file((str)arg1, (str)arg2) → None:
Copy a Geosoft data file and all associated files to a new folder
Parameters:
  • arg1 (str) – File Name
  • arg2 (str) – target directory
Returns:

Nothing
Return type:

None

New in version 7.0.0.

Note:

Grids are copied and the GI's are maintained - note that support
for non-geosoft grids is limited since this method does not
guarantee all grid files besides the main one are copied.
static crc_file((str)arg1) → int:
Compute the CRC of a file
Parameters:arg1 (str) – File Name
Returns:CRC Value
Return type:int

New in version 6.0.1.

static crc_file_offset((str)arg1, (int)arg2) → int:
Compute the CRC of a file with an Offset
Parameters:
  • arg1 (str) – File Name
  • arg2 (int) – Offset in the file (0 for start)
Returns:

CRC Value
Return type:

int

New in version 6.4.0.

static create_clipboard_ra() → GXRA:
Create a RA to read text from the clipboard.
Returns:RA to use for reading.
Return type:geosoft.gxapi.GXRA

New in version 5.0.0.

Note:

Destroy the RA as soon as possible. As long as it
open the clipboard is not accessible from any
application.
static create_clipboard_wa() → GXWA:
Create a WA to write text on the clipboard.
Returns:WA to use for reading.
Return type:geosoft.gxapi.GXWA

New in version 5.0.0.

Note:

Destroy the WA as soon as possible. As long as it
open the clipboard is not accessible from any
application.
static date() → float:
Returns the current date in decimal years.
Returns:Date in decimal years.
Return type:float

New in version 5.0.0.

Note:

The FormatDate_STR function can be used to convert a date to
a string.
static dateto_long((float)arg1) → int:
Converts a double date to a value representing total
days elapsed since day 0 of year 0. This uses the
Numerical Receipies Julian function.
Parameters:arg1 (float) – date
Returns:x - Days
Return type:int

New in version 6.3.0.

static decrypt_string((str)arg1, (str_ref)arg2, (int)arg3) → None:
Decrypts a string that has been previously encrypted by geosoft.gxapi.GXSYS.encrypt_string()().
Parameters:
Returns:

Nothing.
Return type:

None

New in version 9.0.0.

static default_double((str)arg1, (str)arg2, (float)arg3) → None:
Allows a default real to be set.
Parameters:
  • arg1 (str) – Group Name
  • arg2 (str) – Parameter Name
  • arg3 (float) – Real Value to Set
Returns:

Nothing
Return type:

None

New in version 6.0.0.

Note:

The value will only be set if there is no existing
setting.
static default_int((str)arg1, (str)arg2, (int)arg3) → None:
Allows a default int to be set.
Parameters:
  • arg1 (str) – Group Name
  • arg2 (str) – Parameter Name
  • arg3 (int) – Int Value to Set
Returns:

Nothing
Return type:

None

New in version 6.0.0.

Note:

The value will only be set if there is no existing
setting.
static default_string((str)arg1, (str)arg2, (str)arg3) → None:
Allows a default string to be set.
Parameters:
  • arg1 (str) – Group Name
  • arg2 (str) – Parameter Name
  • arg3 (str) – String to Set it To
Returns:

Nothing
Return type:

None

New in version 6.0.0.

Note:

The value will only be set if there is no existing
setting.
static delay((float)arg1) → int:
Idle delay method.
Parameters:arg1 (float) – Decimal Seconds to delay
Returns:success if the delay has elapsed.
Return type:int

New in version 6.0.0.

static delete_file((str)arg1) → int:
Delete a file.
Parameters:arg1 (str) – name of file to delete
Returns:0 if file deleted. 1 if unable to find file or delete file.
Return type:int

New in version 5.0.0.

static delete_gi_file((str)arg1) → int:
Delete the GI file associated with a grid.
Parameters:arg1 (str) – name of grid file to delete
Returns:0 if file deleted. 1 if file is not found, or found but could not be deleted.

This is a “one-line” function to take a grid file name, remove the qualifiers, add the ”.gi” and delete the file.
Return type:int

New in version 5.0.0.

static delete_grid_file((str)arg1) → int:
Delete a grid file and its associated GI and XML files.
Parameters:arg1 (str) – name of grid file to delete
Returns:0 if grid file deleted. 1 if grid file not found or if one or more files is found but could not be deleted.
Return type:int

New in version 7.0.0.

Note:

Deletes the grid file first, and, if they exist, the associated GI
and XML files.
No error is registered if a file is not found or cannot be deleted.
static destroy_ptmp((int)arg1) → None:
Destroy PTMP.
Parameters:arg1 (int) – PTMP object to destroy
Returns:Nothing
Return type:None

New in version 5.0.0.

static dir_exist((str)arg1) → int:
Check to see if a directory exists
Parameters:arg1 (str) – Name of directory to check
Returns:0 - Directory doesn’t exist 1 - Directory exists
Return type:int

New in version 5.0.0.

static disable_gx_debugger() → None:
Disable GX Debugger GUI if active
Returns:Nothing
Return type:None

New in version 5.0.0.

Note:

All breakpoints will be cleared by this call.
static display_double((str)arg1, (float)arg2) → None:
Display a real number.
Parameters:
  • arg1 (str) – Title of the Window
  • arg2 (float) – Number
Returns:

Nothing
Return type:

None

New in version 5.0.0.

static display_help((str)arg1, (str)arg2) → None:
Display the help dialog with the specified topic highlighted
Parameters:
  • arg1 (str) – Group string to lookup in gxhelp.ini
  • arg2 (str) – Index string to lookup in gxhelp.ini
Returns:

Nothing
Return type:

None

New in version 5.0.0.

static display_help_topic((str)arg1, (str)arg2) → None:
Display the help dialog without topic lookup in INI files
Parameters:
  • arg1 (str) – Help File (blank for default)
  • arg2 (str) – Help Topic
Returns:

Nothing
Return type:

None

New in version 5.0.0.

static display_int((str)arg1, (int)arg2) → None:
Display an integer.
Parameters:
  • arg1 (str) – Title of the Window
  • arg2 (int) – number
Returns:

Nothing
Return type:

None

New in version 5.0.0.

static display_message((str)arg1, (str)arg2) → None:
Display a user message.
Parameters:
  • arg1 (str) – Title of the Window
  • arg2 (str) – Message String
Returns:

Nothing
Return type:

None

New in version 5.0.0.

static display_question((str)arg1, (str)arg2) → int:
Display a YES/NO type question. This method waits
for the user to hit YES or NO.
Parameters:
  • arg1 (str) – Title of the window
  • arg2 (str) – Message String
Returns:

0 - user selected No 1 - user selected YES
Return type:

int

New in version 5.0.0.

static display_question_with_cancel((str)arg1, (str)arg2) → int:
Display a YES/NO/CANCEL type question. This method waits
for the user to hit YES or NO or CANCEL.
Parameters:
  • arg1 (str) – Title of the window
  • arg2 (str) – Message String
Returns:

0 - user selected No 1 - user selected YES 2 - user selected CANCEL
Return type:

int

New in version 5.0.0.

static do_command((str)arg1) → None:
Execute an Oasis montaj command.
Parameters:arg1 (str) – Command
Returns:Nothing
Return type:None

New in version 5.0.0.

Note:

Commands syntax:  "[type] command"

type     command
----     -------
ID       Internal Menu Command
See "Internal Menu Commands" in GX Developer documentation.
GX       gx file name
GS       gs file name
DOTNET   dll file name
Use qualifiers to specify class and method e.g. [DOTNET] geogxnet.dll(Geosoft.GX.NewGDB.NewGDB;Run)
PDF      pdf file name
DOS      DOS style command
HLP      help file name

The must be ONE space between the "]" and the command.  For example:

geosoft.gxapi.GXSYS.do_command()("[ID] ID_EDIT_SELECT");  // bring up the line edit tool

See also

ShellExecute_SYS

static emf_object_size((str)arg1, (float_ref)arg2, (float_ref)arg3) → None:
Get the size of an EMF object
Parameters:
Returns:

Nothing
Return type:

None

New in version 6.4.0.

static enable_gx_debugger((str)arg1, (str)arg2) → None:
Enable GX Debugger GUI
Parameters:
  • arg1 (str) – path that will be scanned recursively for GXC source files
  • arg2 (str) – name of gx where first breakpoint should be set
Returns:

Nothing
Return type:

None

New in version 5.0.0.

Note:

Takes as input two strings one a path that will be scanned
recursively for GXC source files and a second string without
a path of the GX where the first breakpoint should be set in (i.e. "gxname.gx").
The source of the GX should be found in the path (e.g. <path>somewheregxname.gxc)
and a breakpoint will be set on the first executing line of this GX. Make sure the
GX binary is newer than the source file, otherwise unexpected results may occur. As
soon as the GX is run the GUI will become visible and it will be possible to set more
breakpoints in any of the GXC files found in the path.
static encrypt_string((str)arg1, (str_ref)arg2, (int)arg3) → None:
Encrypts a string for secure storage in configuration files
or in the workspace parameters.
Parameters:
Returns:

Nothing.
Return type:

None

New in version 9.0.0.

static error((str)arg1, (str)arg2, (int)arg3) → None:
Register an error message
Parameters:
  • arg1 (str) – your error file name, “” if none.
  • arg2 (str) – module name in which error occured.
  • arg3 (int) – error number
Returns:

Nothing
Return type:

None

New in version 5.0.0.

Note:

Use this function to register your own error
messages when an error occurs in your code.  Your
errors can be provided in your own GER file.  See
GEOSOFT.GER for an example of the GER file format.

If the error # is not found in your error file, the
OE32.GER file, then the GEOSOFT.GER file will be
searched.
static error_tag((str)arg1, (str)arg2) → None:
Set an error message tag string
Parameters:
  • arg1 (str) – tag string, ie “%1”.
  • arg2 (str) – string to replace the tag.
Returns:

Nothing
Return type:

None

New in version 5.0.0.

Note:

Use this method to replace tag strings in your error
message text with run-time information.  For example,
Geosoft error messages often use the tag strings "%1",
"%2", etc. as place holders to be replaced by a string
which is only known at run-time.
static exist_double((str)arg1, (str)arg2) → int:
This method checks to see if a real parameter exists.
Parameters:
  • arg1 (str) – Group Name
  • arg2 (str) – Parameter Name
Returns:

1 - Yes 0 - No
Return type:

int

New in version 7.2.0.

static exist_env((str)arg1) → int:
Check if setting exists in environment.
Parameters:arg1 (str) – setting
Returns:1 - Yes 0 - No
Return type:int

New in version 5.0.0.

static exist_int((str)arg1, (str)arg2) → int:
This method checks to see if a int parameter exists.
Parameters:
  • arg1 (str) – Group Name
  • arg2 (str) – Parameter Name
Returns:

1 - Yes 0 - No
Return type:

int

New in version 7.2.0.

static exist_string((str)arg1, (str)arg2) → int:
This method checks to see if a string parameter exists.
Parameters:
  • arg1 (str) – Group Name
  • arg2 (str) – Parameter Name
Returns:

1 - Yes 0 - No
Return type:

int

New in version 7.2.0.

static exit() → None:
This method terminates the execution of a script in  a regular
fashion with no error messages displayed.
Returns:Nothing
Return type:None

New in version 5.0.0.

static file_date((str)arg1) → float:
File creation date in decimal years.
Parameters:arg1 (str) – file name
Returns:Date in decimal years, rDUMMY if the file does not exist.
Return type:float

New in version 5.0.0.

Note:

The FormatDate_STR function can be used to convert a date
to a string.
static file_exist((str)arg1) → int:
Check to see if a file exists
Parameters:arg1 (str) – Name of file to check
Returns:0 - File doesn’t exist 1 - File exists
Return type:int

New in version 5.0.0.

Note:

Use the FULL path for the file name. If the full
path is not specified, then the current working
directory is used for the path.
static file_ren((str)arg1, (str)arg2) → None:
Rename a file
Parameters:
  • arg1 (str) – Old file name
  • arg2 (str) – New file name
Returns:

Nothing
Return type:

None

New in version 5.0.0.

static file_size((str)arg1) → int:
Returns size of a file.
Parameters:arg1 (str) – name of file
Returns:0 none/error x Size
Return type:int

New in version 5.0.0.

static file_time((str)arg1) → float:
File creation time in decimal hours.
Parameters:arg1 (str) – file name
Returns:Date in decimal hours, rDUMMY if the file does not exist.
Return type:float

New in version 5.0.0.

Note:

The FormatTime_STR function can be used to convert a time
to a string.
static file_to_clipboard((str)arg1) → None:
Copy a text file onto the clipboard as text.
Parameters:arg1 (str) – File place into clipboard
Returns:Nothing
Return type:None

New in version 5.0.0.

static file_writable((str)arg1) → bool:
Check if a file can be created or opened in read-write mode
at a specific location
Parameters:arg1 (str) – File path name to check
Returns:bool
Return type:bool

New in version 6.2.0.

static filter_parm_group((str)arg1, (int)arg2) → None:
Controls filtering of specific group during logging.
Parameters:
  • arg1 (str) – Group Name
  • arg2 (int) – 0 - Clear filter, 1 - Add filter
Returns:

Nothing
Return type:

None

New in version 9.1.0.

Note:

This is useful to prevent certain utility GX parameters from being recorded during GS script runs where the parameters does not influence the actual script execution.
static find_files_vv((GXVV)arg1, (str)arg2) → None:
Fill a VV with files matching an input file mask.
Parameters:
Returns:

Nothing
Return type:

None

New in version 5.0.0.

Note:

Fill a VV with files matching the input file mask.
The VV should be of string type.
static find_path((str)arg1, (int)arg2, (str_ref)arg3) → int:
Get full path for a file with Geosoft subdirectory parameter.
Parameters:
Returns:

0 if file found. 1 if file not found.
Return type:

int

New in version 6.0.1.

Note:

Directories can be resolved from the Environment section of the
Geosoft registry, or from system environment variables that are
not defined in the Geosoft Environment registry.  The following
file prefixes will be replaced by the environment settings:

<geosoft>      the main Geosoft installation directory
<geosoft2>     the secondary Geosoft installation directory
<geotemp>      the Geosoft temporary file directory
<windows>      the operating system Windows directory
<system>       the operating system system directory
<other>        other environment variables
static find_path_ex((str)arg1, (int)arg2, (int)arg3, (str_ref)arg4) → int:
Get full path for a file.
Parameters:
Returns:

0 if file found. 1 if file not found.
Return type:

int

New in version 6.0.1.

Note:

Directories can be resolved from the Environment section of the
Geosoft registry, or from system environment variables that are
not defined in the Geosoft Environment registry.  The following
file prefixes will be replaced by the environment settings:

<geosoft>      the main Geosoft installation directory
<geosoft2>     the secondary Geosoft installation directory
<geotemp>      the Geosoft temporary file directory
<windows>      the operating system Windows directory
<system>       the operating system system directory
<other>        other environment variable
static font_lst((GXLST)arg1, (int)arg2) → None:
List all Windows and geosoft fonts.
Parameters:
Returns:

Nothing
Return type:

None

New in version 5.0.0.

Note:

To get TT and GFN fonts, call twice with the same list
and SYS_FONT_TT, then SYS_FONT_GFN, or vice-versa to
change order of listing.
static generate_guid((str_ref)arg1) → None:
Genrates a GUID string (e.g. {4FEDE8BF-CDAB-430A-8026-1CCC0EC0A2EB})
Parameters:arg1 (geosoft.gxapi.str_ref) – GUID
Returns:Nothing
Return type:None

New in version 8.4.0.

static get_directory((int)arg1, (str_ref)arg2) → None:
Get a directory path
Parameters:
Returns:

Nothing
Return type:

None

New in version 5.0.0.

Note:

The path will always end with the file separator character
static get_dot_net_gx_entries((str)arg1, (str_ref)arg2) → int:
Get the list of entry points that this assembly has
exposed to Oasis montaj.
Parameters:
  • arg1 (str) – name of .NET GX assembly
  • arg2 (geosoft.gxapi.str_ref) – buffer to place list of entries in
Returns:

0 success 1 error.
Return type:

int

New in version 6.0.1.

Note:

The list of entry points are passed back as one
string with each entry point seperated by a semi-colon.
For example: NewGDB|Run;NewGDB|RunEx
static get_double((str)arg1, (str)arg2) → float:
This method returns a real from the parameter block.
Parameters:
  • arg1 (str) – Group Name
  • arg2 (str) – Parameter Name
Returns:

Real Value, rDUMMY if parameter not set.
Return type:

float

New in version 6.0.1.

static get_entitlement_rights((GXLST)arg1) → None:
Get the Entitlement Rights
Parameters:arg1 (geosoft.gxapi.GXLST) – Rights
Returns:Nothing
Return type:None

New in version 9.0.0.

static get_env((str)arg1, (str_ref)arg2) → None:
Get an environment setting.
Parameters:
Returns:

Nothing
Return type:

None

New in version 5.0.0.

static get_error_message_ap((int)arg1, (str_ref)arg2) → None:
Return the error message text as a string.
Parameters:
  • arg1 (int) – the error index (0 to N-1, where N=number of registered errors)
  • arg2 (geosoft.gxapi.str_ref) – Buffer to return message in
Returns:

Nothing
Return type:

None

New in version 6.0.0.

Note:

This wrapper is mostly for use outside of GXs,
because in general if an error is registered in a GX
the GX would terminate before it could be called.
Use geosoft.gxapi.GXSYS.num_errors_ap() to get the number of registered errors.
static get_geodist() → int:
Gets a global flag that indicates whether we are
running within the geodist library
Returns:0 - Geodist not loaded, 1 - Geodist loaded
Return type:int

New in version 6.3.0.

static get_int((str)arg1, (str)arg2) → int:
This method returns an int from the parameter block.
Parameters:
  • arg1 (str) – Group Name
  • arg2 (str) – Parameter Name
Returns:

Int Value, iDUMMY if the parameter is not set.
Return type:

int

New in version 6.0.1.

static get_license_class((str_ref)arg1) → None:
Get the current application license class.
Parameters:arg1 (geosoft.gxapi.str_ref) – Class String
Returns:Nothing
Return type:None

New in version 6.1.0.

Note:

String may be one of :  "ArcGIS"
"OasisMontaj"
"DapServer"
static get_licensed_user((str_ref)arg1, (str_ref)arg2) → None:
Get the licensed user name and Company
Parameters:
Returns:

Nothing
Return type:

None

New in version 6.0.0.

static get_loaded_menus((GXLST)arg1, (GXLST)arg2, (GXLST)arg3) → None:
Get the loaded menus.
Parameters:
Returns:

Nothing
Return type:

None

New in version 9.0.0.

Note:

The names of the LSTs contain the menus and the values contain any exclusions. Exlusions 
are semicolon separated top level menu names and/or toolbar.geobar file names.
static get_path((int)arg1, (str_ref)arg2) → None:
Get a Geosoft path
Parameters:
Returns:

Nothing
Return type:

None

New in version 5.0.0.

Note:

The path name will have a directory separator at the end.
static get_pattern((str)arg1, (int_ref)arg2, (float_ref)arg3, (int_ref)arg4, (float_ref)arg5, (int_ref)arg6, (int_ref)arg7) → None:
Gets pattern parameters from the parameter block.
Parameters:
Returns:

Nothing
Return type:

None

New in version 6.4.0.

Note:

Gets all the user-definable pattern parameters from
a specified group. Parameters are:
"PAT_NUMBER"    0 is solid fill (default)
"PAT_SIZE"      pattern tile size in mm. (can return iDUMMY)
"PAT_THICKNESS" pattern line thickness in percent of the tile size.
valid range is 0-100.
"PAT_DENSITY"   Tile spacing. A value of 1 means tiles are laid with no overlap.
A value of 2 means they overlap each other.
"PAT_COLOR"     The colour value.
"PAT_BACKCOLOR" Background colour value.

Returned values may be DUMMY, but will be acceptable for use with
the geosoft.gxapi.GXGUI.color_form() function, to set defaults.
static get_ptmp((int)arg1) → None:
Get temporary saves copy of parameter block.
Parameters:arg1 (int) – saved with Save_PTMP_SYS
Returns:Nothing
Return type:None

New in version 5.0.0.

See also

geosoft.gxapi.GXSYS.save_ptmp(), geosoft.gxapi.GXSYS.destroy_ptmp()

static get_reg((GXREG)arg1, (str)arg2) → None:
Get REG parameters.
Parameters:
Returns:

Nothing
Return type:

None

New in version 5.0.0.

static get_settings_meta((GXMETA)arg1) → None:
Get the settings metadata object.
Parameters:arg1 (geosoft.gxapi.GXMETA) – META object to store the settings metadata in
Returns:Nothing
Return type:None

New in version 6.0.0.

static get_sys_info((int)arg1, (str_ref)arg2) → None:
Get system information
Parameters:
Returns:

Nothing
Return type:

None

New in version 5.0.0.

static get_thread_id() → int:
Get the ID the current thread.
Returns:x - ID
Return type:int

New in version 5.1.6.

Note:

In a single threaded application this will always be 0.
static get_timer((int)arg1, (float_ref)arg2, (float_ref)arg3) → int:
return the elapsed time since the established time.
Parameters:
Returns:

success if the delay has elapsed.
Return type:

int

New in version 6.0.0.

Note:

1st time through call the method with a flag of 1 to identify
the count start time, subsequent times the time will be the time
elapsed since the queried start time.  Do so by settign the flag to 0.
static get_top_error_ap() → int:
Get the error number of the last registered error.
Returns:The top error number registered, 0 if none registered.
Return type:int

New in version 8.0.0.

static get_windows_dir((str_ref)arg1) → None:
Get the Windows directory path
Parameters:arg1 (geosoft.gxapi.str_ref) – Buff for directory path string
Returns:Nothing
Return type:None

New in version 5.0.0.

static get_workspace_reg((GXREG)arg1) → None:
Get a copy of the workspace REG;
Parameters:arg1 (geosoft.gxapi.GXREG) – REG object
Returns:Nothing
Return type:None

New in version 5.0.0.

Note:

The workspace REG is separate from the reg used
to store SYS parameters.

Because geosoft.gxapi.GXSYS.get_workspace_reg() returns a copy of the
workspace REG, and not the workspace REG itself,
you must call geosoft.gxapi.GXSYS.set_workspace_reg() if you make changes
to your own REG object and you wish them to take
effect in the workspace REG.
static get_yes_no((str)arg1, (str)arg2) → int:
Check a YES/NO Setting
Parameters:
  • arg1 (str) – Group Name
  • arg2 (str) – Parameter Name
Returns:

1 - if first char in setting is a “Y” or”y” 0 - Otherwise
Return type:

int

New in version 5.0.0.

static global_((str)arg1, (str_ref)arg2) → int:
Get a global parameter setting.
Parameters:
Returns:

0 if parameter found. 1 if parameter not found or not set.
Return type:

int

New in version 6.0.1.

Note:

The returned string will be empty if the parameter is
not found.

Parameters are derived from GEOSOFT.INI.
This is a standard Windows style INI
file that contains [GROUPS], PARAMETERS and SETTINGS
as follows

[GROUP1]
PARAM1=setting1
PARAM2 setting2
PARAM3 "setting3 is text"

To retrieve an entry, specify the group.parameter.  For
example, iGlobal_SYS("GROUP1.PARAM3",sSetting) will
retrieve the string "setting is text".  The double
quotes will not appear in the setting.
static global_reset((str)arg1) → None:
Reset the global parameters.
Parameters:arg1 (str) – new INI file name, if “”, use default.
Returns:Nothing
Return type:None

New in version 5.0.0.

static global_set((str)arg1, (str)arg2) → None:
Set a global parameter setting.
Parameters:
  • arg1 (str) – Name of the Parameter
  • arg2 (str) – Setting
Returns:

Nothing
Return type:

None

New in version 5.0.0.

static global_write((str)arg1) → None:
Modify the global parameters.
Parameters:arg1 (str) – Global INI file, if “” use default.
Returns:Nothing
Return type:None

New in version 5.0.0.

Note:

If the global parameters have been changed, use
this function to make the changes permanent,
static gt_string((str)arg1, (str)arg2, (str_ref)arg3) → None:
This method returns a string in the parameter block.
Parameters:
  • arg1 (str) – Group Name
  • arg2 (str) – Parameter Name
  • arg3 (geosoft.gxapi.str_ref) – Buffer to place the string into
Returns:

Nothing
Return type:

None

New in version 5.0.0.

Note:

If the setting exits it is placed in the buffer, otherwise
the buffer will have zero length
static interactive() → int:
Checks to see if you should run interactively.
Returns:0 - Run in batch mode only 1 - Run Interactively only
Return type:int

New in version 5.0.0.

static is_encrypted_string((str)arg1) → int:
Checks whether the specified string was encrypted by geosoft.gxapi.GXSYS.encrypt_string()().
Parameters:arg1 (str) – Input string to inspect.
Returns:0 (false) or non-zero (true)
Return type:int

New in version 9.0.0.

static load_parm((str)arg1, (str)arg2) → None:
Reads parameters from a file.
Parameters:
  • arg1 (str) – Name of the File to read from
  • arg2 (str) – Group Name to write read (“” for all groups)
Returns:

Nothing
Return type:

None

New in version 5.0.0.

static log_script_run((str)arg1) → None:
This method logs that a script was run
Parameters:arg1 (str) – Location that launched the script
Returns:Nothing
Return type:None

New in version 9.2.0.

static longto_date((int)arg1) → float:
Converts a value representing total days elapsed since
day 0 of year 0 to a geosoft date. This uses the
Numerical Receipies Julian function.
Parameters:arg1 (int) – day
Returns:x - Date
Return type:float

New in version 6.3.0.

static longto_time((int)arg1) → float:
Converts seconds to decimal hours.
Parameters:arg1 (int) – seconds
Returns:x - Time
Return type:float

New in version 6.3.0.

static make_date((int)arg1, (int)arg2, (int)arg3) → float:
Returns the decimal date given the year, month and day.
Parameters:
  • arg1 (int) – year
  • arg2 (int) – month (0-11)
  • arg3 (int) – day (0-30)
Returns:

Date in decimal years.
Return type:

float

New in version 5.1.1.

static make_dir((str)arg1) → int:
Create a directory.
Parameters:arg1 (str) – Name of directory
Returns:0 - Directory made 1 - Directory cannot be made
Return type:int

New in version 5.0.0.

static make_file_readonly((str)arg1) → int:
Set a file's read-only attribute.
Parameters:arg1 (str) – name of file
Returns:0 if read-only attribute successfully set, 1 if attribute change fails.
Return type:int

New in version 6.3.0.

static make_file_writable((str)arg1) → int:
Removes a file's read-only attribute.
Parameters:arg1 (str) – name of file
Returns:0 if read-only attribute successfully removed, 1 if attribute change fails.
Return type:int

New in version 6.3.0.

static num_errors_ap() → int:
Returns the number of registered errors.
Returns:The number of registered errors.
Return type:int

New in version 6.0.0.

Note:

This wrapper is mostly for use outside of GXs,
because in general if an error is registered in a GX
the GX would terminate before it could be called.

See also

GetErrorMessageAP_SYS

static ole_automation((str)arg1, (str)arg2, (int)arg3) → int:
Call OLE Automation designed to be called from Montaj.
Parameters:
  • arg1 (str) – Object Name
  • arg2 (str) – Info String
  • arg3 (int) – Info Int
Returns:

Return from automation engine.
Return type:

int

New in version 5.0.0.

static prog_name((str)arg1, (int)arg2) → None:
This method allows you to name the current process being
displayed by the progress bar. This method has no affect
if no progress bar exists.
Parameters:
  • arg1 (str) – New Process Name
  • arg2 (int) – 0 - Change the Name but do not change the percentage 1 - Change the Name and Reset Percent to 0 2 - Change the Name but no Percent Bar
Returns:

Nothing
Return type:

None

New in version 5.0.0.

static prog_state() → int:
Return current progress state (On/Off)
Return type:int

New in version 7.2.0.

Note:

This is useful, for instance, when calling one GX from another,
especially if it is called multiple times in a loop.
The called GX may turn the progress ON/OFF on its own, which
means any progress tracking in the calling GX is disrupted.
The called GX should use this function to determine the original
progress state, and not turn off progress if it was already on.

Returns                          0 - Progress is on
- Progress is off
static prog_update((int)arg1) → None:
This method drives the Progress Bar. It is passed
a percentage and will update the bar to reflect that
percentage.
Parameters:arg1 (int) – Percentage Completed (0-100).
Returns:Nothing
Return type:None

New in version 5.0.0.

static prog_update_l((int)arg1, (int)arg2) → None:
Updates progress bar based on count and maxcount.
Parameters:
  • arg1 (int) – count
  • arg2 (int) – max count >= count
Returns:

Nothing
Return type:

None

New in version 5.0.0.

static progress((int)arg1) → None:
This method allows you to turn on the Progress BAR ON/OFF.
Once the progress bar is on, use the UpdateProg method
to drive it.
Parameters:arg1 (int) – 0 - Turn Progress Bar OFF 1 - Turn Progress Bar ON
Returns:Nothing
Return type:None

New in version 5.0.0.

static prompt((str)arg1, (str_ref)arg2) → int:
Asks the User to enter a string.
Parameters:
  • arg1 (str) – Title of the window
  • arg2 (geosoft.gxapi.str_ref) – Buffer to place the user’s string
Returns:

0 - User hit OK 1 - user hit CANCEL
Return type:

int

New in version 5.0.0.

Note:

The User string is displayed as the default value in the prompt.
Empty the user string if no default is needed.
static registry_delete_key((int)arg1, (str)arg2) → int:
Delete a registry value
Parameters:
Returns:

0 - Ok 1 - Error
Return type:

int

New in version 5.0.0.

Note:

All sub-keys and values will be deleted if they exist.
static registry_delete_val((int)arg1, (str)arg2, (str)arg3) → int:
Delete a registry value
Parameters:
Returns:

0 - Ok 1 - Error
Return type:

int

New in version 5.0.0.

static registry_get_val((int)arg1, (str)arg2, (str)arg3, (str_ref)arg4) → int:
Get a registry value
Parameters:
Returns:

0 if value exists 1 if value does not exist
Return type:

int

New in version 6.0.1.

static registry_set_val((int)arg1, (str)arg2, (str)arg3, (str)arg4) → None:
Set/create a registry value
Parameters:
  • arg1 (int) – REG_DOMAIN constants
  • arg2 (str) – Key to set
  • arg3 (str) – Name of Subkey within key
  • arg4 (str) – Value for Subkey
Returns:

Nothing
Return type:

None

New in version 5.0.0.

Note:

This function will create the subkey and key if either do not
already exist.
static relative_file_name((str)arg1, (str_ref)arg2) → None:
Convert a file name to a relative abbreviated path name
Parameters:
  • arg1 (str) – Input file name to resolve
  • arg2 (geosoft.gxapi.str_ref) – Output name, can be the same as input
Returns:

Nothing
Return type:

None

New in version 6.0.1.

Note:

This will produce relative paths based on the workspace
directory into ".name".
static remove_lineage_output((str)arg1) → None:
Remove an output from the current lineage object
Parameters:arg1 (str) – Source Name
Returns:Nothing
Return type:None

New in version 7.0.1.

static remove_lineage_parameter((str)arg1) → None:
Remove a parameter in the current lineage object
Parameters:arg1 (str) – Paramter Name
Returns:Nothing
Return type:None

New in version 7.0.0.

static remove_lineage_source((str)arg1) → None:
Remove a source from the current lineage object
Parameters:arg1 (str) – Source Name
Returns:Nothing
Return type:None

New in version 7.0.0.

static replace_string((str)arg1, (str_ref)arg2, (str)arg3) → None:
Replace "% %" tokens in a string with parameter values
Parameters:
  • arg1 (str) – String to filter replace
  • arg2 (geosoft.gxapi.str_ref) – Output string
  • arg3 (str) – Default group name
Returns:

Nothing
Return type:

None

New in version 5.0.0.

Note:

If parameter does not exist, the token is removed.  Full parameter names,
such as "%group.name%", are used as-is.  Partial parameter names, such as
"%name%" will have the default group attached.
static reset_settings() → None:
Resets the GX_HELP settings in the geosoft.ini file
after changes have been made.
Returns:Nothing
Return type:None

New in version 5.1.8.

static restore_geo_file((str)arg1, (str)arg2) → None:
Backup a Geosoft data file and all associated files to original location
Parameters:
  • arg1 (str) – Backup File Name
  • arg2 (str) – Original file name
Returns:

Nothing
Return type:

None

New in version 7.0.0.

Note:

Grids are copied and the GI's are maintained - note that support
for non-geosoft grids is limited since this method does not
guarantee all grid files besides the main one are copied.
static run((str)arg1, (str)arg2, (int)arg3) → int:
Run a command line process.
Parameters:
Returns:

-1 if failed to execute task Exit status of the task
Return type:

int

New in version 5.0.0.

Note:

The Default option for each define below is the first one
and is set to 0.

We look for the command object in the following order:

1. the local working directory
2. the <geosoft>bin directory
3. the system path
static run_gs((str)arg1) → int:
Run a GS.
Parameters:arg1 (str) – name of GS to run.
Returns:Exit status of the GS -1 cancelled 0 success 1 ended with an error.
Return type:int

New in version 5.0.0.

See also

geosoft.gxapi.GXSYS.set_interactive(), geosoft.gxapi.GXSYS.run_gx()

static run_gx((str)arg1) → int:
Run a GX.
Parameters:arg1 (str) – name of GX to run.
Returns:Exit status of the GX: -1 cancelled 0 success 1 ended with an error.
Return type:int

New in version 5.0.0.

Note:

If the called GX returns an error, they will not be
displayed until the "top" calling GX terminates, unless you
call geosoft.gxapi.GXSYS.show_error()().

See also

geosoft.gxapi.GXSYS.run_gx_ex(), geosoft.gxapi.GXSYS.set_interactive() and geosoft.gxapi.GXSYS.run_gs()

static run_gx_ex((str)arg1, (int_ref)arg2) → int:
Run a GX.
Parameters:
  • arg1 (str) – name of GX to run.
  • arg2 (geosoft.gxapi.int_ref) – return value set in the child GX (0 by default)
Returns:

Exit status of the GX: -1 cancelled 0 success 1 ended with an error.
Return type:

int

New in version 5.0.0.

See also

geosoft.gxapi.GXSYS.run_gx(), geosoft.gxapi.GXSYS.set_return()

static run_multi_user_script((str)arg1, (int)arg2, (int)arg3, (int)arg4, (int)arg5, (int)arg6) → None:
Execute a script using multithreaded users
Parameters:
  • arg1 (str) – Script to run
  • arg2 (int) – Number of users to run
  • arg3 (int) – Number of iterations to run (for each user)
  • arg4 (int) – Minimum wait time between iterations (0 for none)
  • arg5 (int) – Maximum wait time between iterations (0 for none)
  • arg6 (int) – Ramp up time for users (0 for all users start immediatly)
Returns:

Nothing
Return type:

None

New in version 5.1.6.

Note:

No access is provided in the script to EMAPS
or EDBS. Users must ensure that the resources
that are shared are protected.
static run_pdf((str)arg1, (str)arg2) → int:
Run a PDF.
Parameters:
  • arg1 (str) – group name, can be “”.
  • arg2 (str) – pdf name (.pdf assumed)
Returns:

Exit status of the task, 0 usually means success.
Return type:

int

New in version 5.0.0.

Note:

The group name of the PDF variables will be "group_pdf",
where "group" is the name given in the first argument,
and "pdf" is the root PDF file name.
static save_log((str)arg1) → None:
Saves the main log file to another file.
Parameters:arg1 (str) – output file name
Returns:Nothing
Return type:None

New in version 5.0.0.

static save_parm((str)arg1, (int)arg2, (str)arg3) → None:
Writes out one group (or all groups) to a file.
Parameters:
  • arg1 (str) – Name of the File
  • arg2 (int) – 0 - New file, 1 - Append
  • arg3 (str) – Group Name to write out (“” for all groups)
Returns:

Nothing
Return type:

None

New in version 5.0.0.

static save_ptmp((str)arg1) → int:
Save a temporary copy of the parameter block.
Parameters:arg1 (str) – Group Name to save, “” for everything.
Returns:PTMP handle.
Return type:int

New in version 5.0.0.

Note:

All PTMP instances will be destroyed on exit.

See also

geosoft.gxapi.GXSYS.get_ptmp(), geosoft.gxapi.GXSYS.destroy_ptmp()

static script() → int:
Checks to see if we are running inside OMS (script mode)
Returns:0 - Normal mode 1 - Scripting mode

A number of functions can only be run from inside Oasis montaj (such as GetDisplayAreaRaw_EMAP), because they require an actual window object, such as an editable database or map. Use this function to prevent calls
Return type:int

New in version 6.0.1.

static script_record() → int:
Checks to see if we are in scripting recording mode
Returns:0 - Normal mode 1 - Recording mode
Return type:int

New in version 6.3.0.

static secondsto_time((float)arg1) → float:
Converts fractional seconds to decimal hours.
Parameters:arg1 (float) – seconds
Returns:x - Time
Return type:float

New in version 6.3.0.

static send_general_message((str)arg1, (str)arg2) → None:
Send a general information message to all listners
Parameters:
  • arg1 (str) – Message Class
  • arg2 (str) – Message Info
Returns:

Nothing
Return type:

None

New in version 6.3.0.

static set_cursor((str)arg1) → None:
Set the cursor on the display.
Parameters:arg1 (str) – Cursor Names
Returns:Nothing
Return type:None

New in version 5.0.0.

Note:

Possible Cursors:
Normal, Horiz, Vert, Moving, Cross, Hand, NoEdit, Sun,
View, Group, ViewSel, GroupSel, BoxSelect, Shadow, Link,
Line, PolyLine, Polygon, Ellipse, Rectangle, Text, Symbol,
Zoom, Pan, Rotate, InteractiveZoom, PolyFill, GetFill,
SnapPoint, SnapLine, SnapOnPoint, SnapOnLine, NPolygon,
ExcludeRect, ExcludePoly, ExcludeNPoly, AddVertex, DelVertex, GeneralAdd and GeneralDelete
static set_double((str)arg1, (str)arg2, (float)arg3) → None:
This method Sets a real in the parameter block.
Parameters:
  • arg1 (str) – Group Name
  • arg2 (str) – Parameter Name
  • arg3 (float) – Real
Returns:

Nothing
Return type:

None

New in version 5.0.0.

static set_env((str)arg1, (str)arg2) → None:
Set an environment setting.
Parameters:
  • arg1 (str) – setting
  • arg2 (str) – value
Returns:

Nothing
Return type:

None

New in version 5.0.0.

static set_info_line((str)arg1) → None:
Display a message on the information line at the left
bottom corner of the OAISIS montaj application.
Parameters:arg1 (str) – Message String
Returns:Nothing
Return type:None

New in version 5.0.0.

static set_int((str)arg1, (str)arg2, (int)arg3) → None:
This method sets an int in the parameter block.
Parameters:
  • arg1 (str) – Group Name
  • arg2 (str) – Parameter Name
  • arg3 (int) – Int Value to Set
Returns:

Nothing
Return type:

None

New in version 5.0.0.

static set_interactive((int)arg1) → None:
Sets the interactive mode.
Parameters:arg1 (int) – 0 - interactive off 1 - interative on
Returns:Nothing
Return type:None

New in version 5.0.0.

Note:

Call to geosoft.gxapi.GXSYS.interactive() will return the value
set here.

See also

geosoft.gxapi.GXSYS.interactive(), geosoft.gxapi.GXSYS.run_gx() and geosoft.gxapi.GXSYS.run_gs()

static set_lineage_description((str)arg1) → None:
Set the description for the current lineage object
Parameters:arg1 (str) – Description
Returns:Nothing
Return type:None

New in version 7.0.0.

static set_lineage_display_name((str)arg1) → None:
Set the display name for the current lineage object
Parameters:arg1 (str) – DisplayName
Returns:Nothing
Return type:None

New in version 7.0.0.

static set_lineage_name((str)arg1) → None:
Set the name for the current lineage object
Parameters:arg1 (str) – Name
Returns:Nothing
Return type:None

New in version 7.0.0.

static set_loaded_menus((GXLST)arg1, (GXLST)arg2, (GXLST)arg3) → None:
Load a list of menus
Parameters:
Returns:

Nothing
Return type:

None

New in version 9.0.0.

Note:

The names of the LSTs contain the menus and the values contain any exclusions. Exlusions 
are semicolon separated top level menu names and/or toolbar.geobar file names.
static set_pattern((str)arg1, (int)arg2, (float)arg3, (int)arg4, (float)arg5, (int)arg6, (int)arg7) → None:
Sets pattern parameters in the parameter block.
Parameters:
  • arg1 (str) – Group Name
  • arg2 (int) – Pattern
  • arg3 (float) – Size. Input GS_R8DM to use default
  • arg4 (int) – Thickness (0-100). Input GS_S4DM to use default
  • arg5 (float) – Density. Input GS_R8DM to use default
  • arg6 (int) – Pattern Color
  • arg7 (int) – Background Color. Can be C_TRANSPARENT
Returns:

Nothing
Return type:

None

New in version 6.4.0.

Note:

Sets all the user-definable pattern parameters to
a specified group. Parameters are:
"PAT_NUMBER"    0 is solid fill
"PAT_SIZE"      pattern tile size in mm.
"PAT_THICKNESS" pattern line thickness in percent of the tile size.
valid range is 0-100.
"PAT_DENSITY"   Tile spacing. A value of 1 means tiles are laid with no overlap.
A value of 2 means they overlap each other.
"PAT_COLOR"     The colour value.
"PAT_BACKCOLOR" Background colour value.

Input values may be DUMMY.

Designed for use along with the sPatternForm_GUI function.
static set_reg((GXREG)arg1) → None:
Copy contents of a REG to current parameters.
Parameters:arg1 (geosoft.gxapi.GXREG) – REG object
Returns:Nothing
Return type:None

New in version 5.0.0.

static set_return((int)arg1) → None:
Set the return value of a GX.
Parameters:arg1 (int) – Return Value
Returns:Nothing
Return type:None

New in version 5.0.0.

Note:

This value is returned in the geosoft.gxapi.GXSYS.run_gx_ex() call only.
static set_server_messages_ap((int)arg1) → None:
Control the server message handling.
Parameters:arg1 (int) – 1 - Display messages, 0 - messages reported as errors
Returns:Nothing
Return type:None

New in version 6.2.0.

Note:

Should be set to false when dialogs should not
appear. This setting is thread specific.
static set_settings_meta((GXMETA)arg1) → None:
Set the settings metadata object.
Parameters:arg1 (geosoft.gxapi.GXMETA) – META object
Returns:Nothing
Return type:None

New in version 6.0.0.

static set_string((str)arg1, (str)arg2, (str)arg3) → None:
This method sets a string in the parameter block.
Parameters:
  • arg1 (str) – Group Name
  • arg2 (str) – Parameter Name
  • arg3 (str) – String to Set it To
Returns:

Nothing
Return type:

None

New in version 5.0.0.

static set_workspace_reg((GXREG)arg1) → None:
Set the workspace REG;
Parameters:arg1 (geosoft.gxapi.GXREG) – REG object
Returns:Nothing
Return type:None

New in version 5.0.0.

Note:

The workspace REG is separate from the reg used
to store SYS parameters.

Because geosoft.gxapi.GXSYS.get_workspace_reg() returns a copy of the
workspace REG, and not the workspace REG itself,
you must call geosoft.gxapi.GXSYS.set_workspace_reg() if you make changes
to your own REG object and you wish them to take
effect in the workspace REG
static shell_execute((str)arg1, (str)arg2, (str)arg3, (str)arg4, (int)arg5) → int:
MS ShellExecute function
Parameters:
  • arg1 (str) – Verb
  • arg2 (str) – File
  • arg3 (str) – Parameters
  • arg4 (str) – Directory
  • arg5 (int) – SHELL_EXECUTE constants
Returns:

return value of ShellExecute command

See ShellExecute description in MSDN
Return type:

int

New in version 5.0.0.

Note:

Examples

geosoft.gxapi.GXSYS.shell_execute()(open;http://www.geosoft.com);
geosoft.gxapi.GXSYS.shell_execute()(open;"mailto:geonet@lists.geosoft.com");
geosoft.gxapi.GXSYS.shell_execute()(open;"mailto:majordomo@lists.geosoft.com?body=UNSUBSCRIBE%20gxnet");

See also

geosoft.gxapi.GXSYS.do_command()

static short_path_file_name((str)arg1, (str_ref)arg2) → None:
Obtains the short path form of a specified input path.
Parameters:
  • arg1 (str) – Input file name to resolve
  • arg2 (geosoft.gxapi.str_ref) – Output name, can be the same as input
Returns:

Nothing
Return type:

None

New in version 5.0.0.

static show_error() → None:
Display any errors to the user.
Returns:Nothing
Return type:None

New in version 5.0.0.

Note:

If you call a GX from another GX using geosoft.gxapi.GXSYS.run_gx(), and
the called GX registers errors, they will not be displayed
until after the "top" GX exits.
If you wish to continue without exiting, call this function
so that errors are displayed immediately to the user. For
instance, when creating a new map from inside another GX:

--- Run NEWMAP wizard. Keep trying if something is wrong (like a
too-small map scale), but exit if the user cancels (iRet==-1) ---

do {
iRet = geosoft.gxapi.GXSYS.run_gx()("newmap.gx");
if(iRet==1) geosoft.gxapi.GXSYS.show_error()();     // Dump errors.
} while(iRet==1);

This wrapper is not intended for use outside a GX, because it
uses the GX run-time machinery to display the error messages.
static temp_file_ext((str)arg1, (str_ref)arg2) → None:
Generate a unique file name for this extension in the temp directory.
Parameters:
Returns:

Nothing
Return type:

None

New in version 5.1.8.

Note:

This is useful for created a unique tempory name for a file in the Geosoft temporary directory.
static temp_file_name((str)arg1, (str_ref)arg2) → None:
Generate a file name for this file in the temp directory.
Parameters:
  • arg1 (str) – Input file name to resolve (path is removed)
  • arg2 (geosoft.gxapi.str_ref) – Output name, can be the same as input
Returns:

Nothing
Return type:

None

New in version 5.0.0.

Note:

This is useful for created a unique tempory name for a file in the Geosoft temporary directory.

From version 7.0 The file extension will match the input file, but the
filename itself will be a process and thread unique value to ensure that
clashes does not happen.
static terminate((str)arg1) → None:
DLL error termination
Parameters:arg1 (str) – module name
Returns:Nothing
Return type:None

New in version 5.0.0.

Note:

Call this function immediately before returning to
the caller after an error has occured inside the
DLL.  If an error has occured, you should clean-up
(free memory, close files), call geosoft.gxapi.GXSYS.error() to register
your own error messages, call geosoft.gxapi.GXSYS.error_tag() to set any
error message tags, call geosoft.gxapi.GXSYS.terminate() and return.

Geosoft functions that detect an error will have
already registered their own errors and called
geosoft.gxapi.GXSYS.terminate().
static time() → float:
Returns the current time in decimal hours.
Returns:Time in decimal hours.
Return type:float

New in version 5.0.0.

Note:

The FormatTime_STR function can be used to convert a time to
a string.
static timeto_long((float)arg1) → int:
Converts decimal hours to seconds in a day.
Parameters:arg1 (float) – Time
Returns:x - Seconds (integer)
Return type:int

New in version 6.3.0.

static timeto_seconds((float)arg1) → float:
Converts decimal hours to seconds in a day fractional
Parameters:arg1 (float) – Time
Returns:x - Number of seconds with fractions
Return type:float

New in version 6.3.0.

static transfer_path((str)arg1, (str_ref)arg2) → None:
Transfers file path to new file name.
Parameters:
  • arg1 (str) – input file path/name
  • arg2 (geosoft.gxapi.str_ref) – output file name with path transfered
Returns:

Nothing
Return type:

None

New in version 5.1.8.

Note:

The path and volume of from the input string is added to
file name from the output string.
static utc_date() → float:
Returns the current UTC date in decimal years.
Returns:Date in decimal years.
Return type:float

New in version 7.0.0.

Note:

The FormatDate_STR function can be used to convert a date to
a string.
static utc_file_date((str)arg1) → float:
File creation UTC date in decimal years.
Parameters:arg1 (str) – file name
Returns:Date in decimal years, rDUMMY if the file does not exist.
Return type:float

New in version 7.0.0.

Note:

The FormatDate_STR function can be used to convert a date
to a string.
static utc_file_time((str)arg1) → float:
File creation UTC time in decimal hours.
Parameters:arg1 (str) – file name
Returns:Date in decimal hours, rDUMMY if the file does not exist.
Return type:float

New in version 7.0.0.

Note:

The FormatTime_STR function can be used to convert a time
to a string.
static utc_time() → float:
Returns the current UTC time in decimal hours.
Returns:Time in decimal hours.
Return type:float

New in version 7.0.0.

Note:

The FormatTime_STR function can be used to convert a time to
a string.
static valid_file_name((str)arg1) → int:
Check to see if a file name valid
Parameters:arg1 (str) – Name of file to check
Returns:0 - File name is not valid 1 - File name is valid
Return type:int

New in version 5.0.0.

Note:

Use the FULL path for the file name. If the full
path is not specified, then the current working
directory is used for the path.
static write_debug_log((str)arg1) → None:
This method writes out information to the output
debugging log file (in temp folder) or output window.
Parameters:arg1 (str) – String to Write out
Returns:Nothing
Return type:None

New in version 6.3.0.

static write_in_dir((str)arg1) → int:
Can I create files in this directory ?
Parameters:arg1 (str) – Name of directory to check
Returns:0 - Directory doesn’t allow write of does not exist 1 - Directory allows writes
Return type:int

New in version 5.0.0.

ARC_LICENSE constants

ArcGIS platform types
gxapi.ARC_LICENSE_ENGINENOTPRESENT = 0
The Engine or any qualifying ArcGIS product is missing
gxapi.ARC_LICENSE_DESKTOPENGINE = 1
Desktop Engine
gxapi.ARC_LICENSE_ARCVIEW = 2
ArcView
gxapi.ARC_LICENSE_ARCEDITOR = 3
ArcEditor
gxapi.ARC_LICENSE_ARCINFO = 4
ArcInfo
gxapi.ARC_LICENSE_ARCSERVER = 5
ArcServer

GEO_DIRECTORY constants

Geosoft directory defines
gxapi.GEO_DIRECTORY_NONE = 0
None
gxapi.GEO_DIRECTORY_GEOSOFT = 1
Geosoft\
gxapi.GEO_DIRECTORY_BIN = 2
Geosoft\bin
gxapi.GEO_DIRECTORY_GER = 3
Geosoft\ger
gxapi.GEO_DIRECTORY_OMN = 4
Geosoft\omn
gxapi.GEO_DIRECTORY_TBL = 5
Geosoft\tbl
gxapi.GEO_DIRECTORY_FONTS = 6
Geosoft\fonts
gxapi.GEO_DIRECTORY_GX = 7
Geosoft\gx
gxapi.GEO_DIRECTORY_GS = 8
Geosoft\gs
gxapi.GEO_DIRECTORY_APPS = 9
Geosoft\apps
gxapi.GEO_DIRECTORY_ETC = 10
Geosoft\user\etc and then Geosoft\etc
gxapi.GEO_DIRECTORY_HLP = 11
Geosoft\hlp
gxapi.GEO_DIRECTORY_USER_CSV = 14
Geosoft\user\csv
gxapi.GEO_DIRECTORY_USER_LIC = 15
Geosoft\user\lic
gxapi.GEO_DIRECTORY_USER_INI = 16
Geosoft\user\ini
gxapi.GEO_DIRECTORY_USER_TEMP = 17
Geosoft\temp (or where the user put it)
gxapi.GEO_DIRECTORY_USER_ETC = 18
Geosoft\user\etc
gxapi.GEO_DIRECTORY_IMG = 19
Geosoft\img
gxapi.GEO_DIRECTORY_BAR = 20
Geosoft\bar
gxapi.GEO_DIRECTORY_MAPTEMPLATE = 22
Geosoft\maptemplate
gxapi.GEO_DIRECTORY_USER_MAPTEMPLATE = 23
Geosoft\user\maptemplate
gxapi.GEO_DIRECTORY_PYGX = 24
Geosoft\pygx
gxapi.GEO_DIRECTORY_USER_PYGX = 25
Geosoft\user\pygx
gxapi.GEO_DIRECTORY_USER_GX = 26
Geosoft\user\gx

REG_DOMAIN constants

Registry key domains
gxapi.REG_DOMAIN_MACHINE = 0
same as HKEY_LOCAL_MACHINE in Windows
gxapi.REG_DOMAIN_USER = 1
same as HKEY_CURRENT_USER in Windows

SHELL_EXECUTE constants

Shell execute defines
gxapi.SW_HIDE = 0
gxapi.SW_SHOWNORMAL = 1
gxapi.SW_SHOWMINIMIZED = 2
gxapi.SW_SHOWMAXIMIZED = 3
gxapi.SW_SHOWNOACTIVATE = 4
gxapi.SW_SHOW = 5
gxapi.SW_MINIMIZE = 6
gxapi.SW_SHOWMINNOACTIVE = 7
gxapi.SW_SHOWNA = 8
gxapi.SW_RESTORE = 9
gxapi.SW_SHOWDEFAULT = 10
gxapi.SW_FORCEMINIMIZE = 11

SYS_DIR constants

SYS Directory locations
gxapi.SYS_DIR_LOCAL = 0
is the workspace working directory
gxapi.SYS_DIR_GEOSOFT = 1
is the geosoft installation directory (read-only)
gxapi.SYS_DIR_USER = 2
is the geosoft installation directory that
contains user read/write files.
gxapi.SYS_DIR_GEOTEMP = 3
Geosoft Temp folder
gxapi.SYS_DIR_WINDOWS = 4
Windows folder
gxapi.SYS_DIR_SYSTEM = 5
Windows SYSTEM folder
gxapi.SYS_DIR_LICENSE = 6
Where the license file is stored
gxapi.SYS_DIR_RESOURCEFILES = 7
User RESOURCEFILES Folder
gxapi.SYS_DIR_GEOSOFT_BAR = 100
BAR folder
gxapi.SYS_DIR_GEOSOFT_BIN = 101
BIN folder
gxapi.SYS_DIR_GEOSOFT_CSV = 102
CSV folder
gxapi.SYS_DIR_GEOSOFT_CSV_ALIASES = 103
CSV ALIASES folder
gxapi.SYS_DIR_GEOSOFT_DATA = 104
DATA folder
gxapi.SYS_DIR_GEOSOFT_DBG = 105
DBG folder
gxapi.SYS_DIR_GEOSOFT_ENCRYPTEDFILES = 106
Encrypted Files folder
gxapi.SYS_DIR_GEOSOFT_ETC = 107
ETC folder
gxapi.SYS_DIR_GEOSOFT_FONTS = 108
FONTS folder
gxapi.SYS_DIR_GEOSOFT_GER = 109
GER folder
gxapi.SYS_DIR_GEOSOFT_GS = 110
GS folder
gxapi.SYS_DIR_GEOSOFT_GX = 111
GX folder
gxapi.SYS_DIR_GEOSOFT_HLP = 112
HLP folder
gxapi.SYS_DIR_GEOSOFT_IMG = 113
IMG folder
gxapi.SYS_DIR_GEOSOFT_INI = 114
INI folder
gxapi.SYS_DIR_GEOSOFT_MAPTEMPLATE = 115
MAPTEMPLATE folder
gxapi.SYS_DIR_GEOSOFT_OMN = 116
OMN folder
gxapi.SYS_DIR_GEOSOFT_PAGE = 117
PAGE folder
gxapi.SYS_DIR_GEOSOFT_SCHEMA = 118
SCHEMA folder
gxapi.SYS_DIR_GEOSOFT_SPEC_INI = 119
SPEC INI older
gxapi.SYS_DIR_GEOSOFT_STYLESHEETS = 120
STYLE SHEETS folder
gxapi.SYS_DIR_GEOSOFT_TBL = 121
TBL folder
gxapi.SYS_DIR_USER_CSV = 200
User CSV Folder
gxapi.SYS_DIR_USER_ETC = 201
User ETC Folder
gxapi.SYS_DIR_USER_GS = 202
User GS Folder
gxapi.SYS_DIR_USER_HLP = 203
User HLP Folder
gxapi.SYS_DIR_USER_INI = 204
User INI Folder
gxapi.SYS_DIR_USER_LIC = 205
User LIC Folder
gxapi.SYS_DIR_USER_MAPTEMPLATE = 206
User MAPTEMPLATE Folder
gxapi.SYS_DIR_USER_OMN = 207
User OMN Folder
gxapi.SYS_DIR_USER_BAR = 214
User BAR Folder
gxapi.SYS_DIR_USER_IMG = 215
User IMG Folder
gxapi.SYS_DIR_USER_STACKS = 209
User STACKS Folder
gxapi.SYS_DIR_USER_TEMP = 210
User TEMP Folder
gxapi.SYS_DIR_USER_SERVICES = 211
User SERVICES Folder
gxapi.SYS_DIR_USER_STYLESHEETS = 212
User STYLESHEETS Folder

SYS_FONT constants

Font types
gxapi.SYS_FONT_GFN = 1
Geosoft GFN fonts.
gxapi.SYS_FONT_TT = 0
available TrueType fonts

SYS_INFO constants

System information
gxapi.SYS_INFO_VERSION_MAJOR = 0
gxapi.SYS_INFO_VERSION_MINOR = 1
gxapi.SYS_INFO_VERSION_SP = 2
gxapi.SYS_INFO_BUILD_NUMBER = 3
gxapi.SYS_INFO_BUILD_LABEL = 4
gxapi.SYS_INFO_VERSION_LABEL = 5
gxapi.SYS_INFO_PRODUCTNAME = 6
gxapi.SYS_INFO_SERVERNAME = 7
gxapi.SYS_INFO_LEGALCOPYRIGHT = 8
gxapi.SYS_INFO_REGISTRY = 9
gxapi.SYS_INFO_REGISTRY_ENVIRONMENT = 10
gxapi.SYS_INFO_REGISTRY_SUPPORT = 11
gxapi.SYS_INFO_REGISTRY_INTERAPP = 12
gxapi.SYS_INFO_OIS_REGISTRY = 13
gxapi.SYS_INFO_TEST_REGISTRY = 14

SYS_LINEAGE_SOURCE constants

Type of lineage sources
gxapi.SYS_LINEAGE_SOURCE_MAP = 0
gxapi.SYS_LINEAGE_SOURCE_MXD = 1
gxapi.SYS_LINEAGE_SOURCE_DB = 2
gxapi.SYS_LINEAGE_SOURCE_MAPTEMPLATE = 3
gxapi.SYS_LINEAGE_SOURCE_GRID = 4
gxapi.SYS_LINEAGE_SOURCE_VOXEL = 5

SYS_MENU_CLEAR constants

Font types
gxapi.SYS_MENU_CLEAR_ALL = 0
Clear all menus excluding the coremenus.omn
but including any default menus specified in the settings (these will not come back in this project).
gxapi.SYS_MENU_CLEAR_DEFAULT = 1
Clear all menus excluding the coremenus.omn
but reload any default menus specified in the settings (essentially this is a refresh
back to the default state again).

SYS_PATH constants

Get specific Geosoft paths. The path name will
have a directory separator at the end.
gxapi.SYS_PATH_LOCAL = 0
is the workspace working directory
gxapi.SYS_PATH_GEOSOFT = 1
is the geosoft installation directory (read-only)
gxapi.SYS_PATH_GEOSOFT_USER = 2
is the geosoft installation directory that
contains user read/write files.
gxapi.SYS_PATH_GEOTEMP = 3
Geosoft Temp folder
gxapi.SYS_PATH_WINDOWS = 4
Windows folder
gxapi.SYS_PATH_SYSTEM = 5
System folder
gxapi.SYS_PATH_LICENSE = 6
Where the license file is stored
gxapi.SYS_PATH_RESOURCEFILES = 7
User RESOURCEFILES Folder
gxapi.SYS_PATH_GEOSOFT_BAR = 100
BAR folder
gxapi.SYS_PATH_GEOSOFT_BIN = 101
BIN folder
gxapi.SYS_PATH_GEOSOFT_CSV = 102
CSV folder
gxapi.SYS_PATH_GEOSOFT_CSV_ALIASES = 103
CSV ALIASES folder
gxapi.SYS_PATH_GEOSOFT_DATA = 104
DATA folder
gxapi.SYS_PATH_GEOSOFT_DBG = 105
DBG folder
gxapi.SYS_PATH_GEOSOFT_ENCRYPTEDFILES = 106
Encrypted Files folder
gxapi.SYS_PATH_GEOSOFT_ETC = 107
ETC folder
gxapi.SYS_PATH_GEOSOFT_FONTS = 108
FONTS folder
gxapi.SYS_PATH_GEOSOFT_GER = 109
GER folder
gxapi.SYS_PATH_GEOSOFT_GS = 110
GS folder
gxapi.SYS_PATH_GEOSOFT_PYGX = 126
PYGX folder
gxapi.SYS_PATH_GEOSOFT_GX = 111
GX folder
gxapi.SYS_PATH_GEOSOFT_HLP = 112
HLP folder
gxapi.SYS_PATH_GEOSOFT_IMG = 113
IMG folder
gxapi.SYS_PATH_GEOSOFT_INI = 114
INI folder
gxapi.SYS_PATH_GEOSOFT_MAPTEMPLATE = 115
MAPTEMPLATE folder
gxapi.SYS_PATH_GEOSOFT_OMN = 116
OMN folder
gxapi.SYS_PATH_GEOSOFT_PAGE = 117
PAGE folder
gxapi.SYS_PATH_GEOSOFT_SCHEMA = 118
SCHEMA folder
gxapi.SYS_PATH_GEOSOFT_SPEC_INI = 119
SPEC INI older
gxapi.SYS_PATH_GEOSOFT_STYLESHEETS = 120
STYLE SHEETS folder
gxapi.SYS_PATH_GEOSOFT_TBL = 121
TBL folder
gxapi.SYS_PATH_GEOSOFT_USER_CSV = 200
User CSV Folder
gxapi.SYS_PATH_GEOSOFT_USER_ETC = 201
User ETC Folder
gxapi.SYS_PATH_GEOSOFT_USER_GS = 202
User GS Folder
gxapi.SYS_PATH_GEOSOFT_USER_GX = 217
User GX Folder
gxapi.SYS_PATH_GEOSOFT_USER_PYGX = 216
User PYGX Folder
gxapi.SYS_PATH_GEOSOFT_USER_HLP = 203
User HLP Folder
gxapi.SYS_PATH_GEOSOFT_USER_INI = 204
User INI Folder
gxapi.SYS_PATH_GEOSOFT_USER_LIC = 205
User LIC Folder
gxapi.SYS_PATH_GEOSOFT_USER_MAPTEMPLATE = 206
User MAPTEMPLATE Folder
gxapi.SYS_PATH_GEOSOFT_USER_OMN = 207
User OMN Folder
gxapi.SYS_PATH_GEOSOFT_USER_STACKS = 209
User STACKS Folder
gxapi.SYS_PATH_GEOSOFT_USER_TEMP = 210
User TEMP Folder
gxapi.SYS_PATH_USER_SERVICES = 211
User SERVICES Folder
gxapi.SYS_PATH_USER_STYLESHEETS = 212
User STYLESHEETS Folder

SYS_RUN_DISPLAY constants

Windows Display Options
Determine how applications are started.
These options are not yet implemented.
gxapi.SYS_RUN_DISPLAY_WINDOW = 0
In a window  (default)
gxapi.SYS_RUN_DISPLAY_MINIMIZE = 8
Maximized
gxapi.SYS_RUN_DISPLAY_FULLSCREEN = 16
Full Screen

SYS_RUN_HOLD constants

DOS Console Options
These options determine if and when the DOS/EXE
console window is held. These options only work
on DOS and EXE programs.
gxapi.SYS_RUN_HOLD_NEVER = 0
Don't wait (Default)
gxapi.SYS_RUN_HOLD_ONERROR = 512
Hold the screen if there is an error
gxapi.SYS_RUN_HOLD_ALWAYS = 1024
Always hold the screen

SYS_RUN_TYPE constants

Type of application to run
gxapi.SYS_RUN_TYPE_DOS = 1
Things such as .BAT files, copy commands, etc. (A console window is created)
gxapi.SYS_RUN_TYPE_EXE = 0
Any program (.EXE) (a console window is created)
gxapi.SYS_RUN_TYPE_WINDOWS = 2
Windows applications that do not require a console window.

SYS_RUN_WIN constants

Windows Options
Should we wait for the application to
finish or should we continue executing. If you wait
for another program, Oasis montaj will not
redraw or respond. We always wait for EXE and DOS programs.
gxapi.SYS_RUN_WIN_NOWAIT = 0
Never wait (default)
gxapi.SYS_RUN_WIN_WAIT = 2048
Always wait

SYS_SEARCH_PATH constants

Find File define
gxapi.FIND_LOCAL_GEOSOFT = 0
Local and then Geosoft directory
gxapi.FIND_GEOSOFT = 1
Geosoft directory
gxapi.FIND_LOCAL = 2
Local directory
gxapi.FIND_SHORT = 1024
Make the name short (FLAG that is added on)

SYS_ENCRYPTION_KEY constants

How to encrypt a string. Determines the portability of the encrypted string.
gxapi.SYS_ENCRYPTION_KEY_GEOSOFT_ID = 0
Encrypt string to currently signed-in user. The string can be decrypted
by the same user on any machine.
gxapi.SYS_ENCRYPTION_KEY_GLOBAL_ID = 1
Encrypt string to current machine. The string can be decrypted by any
user on the same machine.