GXARCDH class

class geosoft.gxapi.GXARCDH
This library is not a class. It contains various utilities
used in the Target extension for ArcGIS.
static close_project() → None:
Closes the current DH project in the Target extension
Returns:Nothing
Return type:None

New in version 8.0.0.

static geostrings_extension_available() → int:
Verifies if the geostrings extension in TfA is available. Return 1 if true, 0 otherwise
Returns:Nothing
Return type:int

New in version 8.0.1.

static get_current_string_file_gdb((str_ref)arg1) → None:
Gets the current Geostring File Geodatabase.
Parameters:arg1 (geosoft.gxapi.str_ref) – name returned
Returns:Nothing
Return type:None

New in version 8.0.1.

static has_string_file_gdb_edits() → int:
Is a Geostring File Geodatabase loaded and contain edits?
Returns:Nothing
Return type:int

New in version 8.0.1.

static is_valid_feature_class_name((str)arg1) → int:
Is this a valid featureclass name?
Parameters:arg1 (str) – featureclass name
Returns:Nothing
Return type:int

New in version 8.0.1.

static is_valid_fgdb_file_name((str)arg1) → int:
Is this a valid FGDB filename?
Parameters:arg1 (str) – FGDB filename
Returns:Nothing
Return type:int

New in version 8.0.1.

static s_prompt_for_esri_symbol((HWND)arg1, (str)arg2, (int)arg3, (str_ref)arg4, (int_ref)arg5, (int_ref)arg6) → None:
Prompt the user to select an ESRI symbol and return it as an XML string. The output string will be empty if the user cancels the dialog.
Parameters:
  • arg1 (geosoft.gxapi.HWND) – Window handle
  • arg2 (str) – Initial symbol that you want displayed when the dialog is launched (use “” if none)
  • arg3 (int) – (This parameter is ignored if an initial symbol was specified) Initial symbol type that you want displayed when the dialog is launched (0 for Fill, 1 for Line)
  • arg4 (geosoft.gxapi.str_ref) – Returned XML string representing the symbol that was chosen by the user
  • arg5 (geosoft.gxapi.int_ref) – RGBA representation of fill color to be set
  • arg6 (geosoft.gxapi.int_ref) – RGBA representation of edge color to be set
Returns:

Nothing
Return type:

None

New in version 8.2.0.

static set_project((str)arg1, (str)arg2) → None:
Sets the current DH project in the Target extension
Parameters:
  • arg1 (str) – Path String
  • arg2 (str) – Project Name
Returns:

Nothing
Return type:

None

New in version 8.0.0.

static set_string_file_gdb((str)arg1) → None:
Sets the current Geostring File Geodatabase in the Target extension
Parameters:arg1 (str) – File Geodatabase
Returns:Nothing
Return type:None

New in version 8.0.0.

static stop_editing_string_file_gdb() → None:
Stops editing session for current string fGDB
Returns:Nothing
Return type:None

New in version 8.0.1.