 | CSYS Methods |
The CSYS type exposes the following members.
Methods| Name | Description | |
|---|---|---|
  | Abort |
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.
|
| AddLineageParameter | Add a parameter to the current lineage object |
| AddLineageSource | Add a source to the current lineage object |
| Assert | Abort with GX line number if not true. |
| BreakDate | Breaks a decimal date value into year, month and day. |
| Cancel |
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.
|
| CheckProductUpdates | Check for product updates via Geosoft Connect |
| ClearGroup | Clear current contents of a group |
| ClearGroupParm | Clears all paramters in a specified group. |
| ClearLineageParameters | Clear all the lineage parameters |
| ClearLineageSources | Clear all the lineage sources |
| ClearMenus | Clear all menus |
| ClearParm | Clears all paramters. |
| ClipboardToFile | Copy text from the clipboard to a file. |
| ConnectWithCurrentCentralInstance(CGXNETCore, String, String, String, String) | Query information necessary to communicate with current Central Instance |
| ConnectWithCurrentCentralInstance(CGXNETCore, String, Int32, String, Int32, String, Int32, String, Int32) | Query information necessary to communicate with current Central Instance |
| CopyGeoFile | Copy a Geosoft data file and all associated files to a new folder |
| CRCFile | Compute the CRC of a file |
| CRCFileOffset | Compute the CRC of a file with an Offset |
| CreateClipboardRA | Create a RA to read text from the clipboard. |
| CreateClipboardWA | Create a WA to write text on the clipboard. |
| DATListLST |
Returns a LST of Grid/Image types as names and qualifiers as valuesLST
Example:
NAME: "Geosoft default (*.grd)"
VALUE: "GRD"
|
| DecryptString(CGXNETCore, String, String, Int32) | Decrypts a string that has been previously encrypted by EncryptString_SYS. |
| DecryptString(CGXNETCore, String, String, Int32, Int32) | Decrypts a string that has been previously encrypted by EncryptString_SYS. |
| DefaultInt | Allows a default int to be set. |
| DefaultReal | Allows a default real to be set. |
| DefaultString | Allows a default string to be set. |
| DeleteDirectory | Delete a directory and all files/subdirectories contained therein. |
| Destr | Destroy ANY object made with a Create_? method |
| DestroyPTMP | Destroy PTMP. |
| DisableGXDebugger | Disable GX Debugger GUI if active |
| DisplayHelp | Display the help dialog with the specified topic highlighted |
| DisplayHelpTopic | Display the help dialog without topic lookup in INI files |
| DisplayInt | Display an integer. |
| DisplayMessage | Display a user message. |
| DisplayReal | Display a real number. |
| DoCommand | Execute an Oasis montaj command. |
| EMFObjectSize | Get the size of an EMF object |
| EnableGXDebugger(CGXNETCore, String, String) | Enable GX Debugger GUI |
| EnableGXDebugger(CGXNETCore, IWin32Window, String, String) | Enable GX Debugger GUI |
| EncryptString(CGXNETCore, String, String, Int32) |
Encrypts a string for secure storage in configuration files
or in the workspace parameters.
|
| EncryptString(CGXNETCore, String, String, Int32, Int32) |
Encrypts a string for secure storage in configuration files
or in the workspace parameters.
|
| Error | Register an error message |
| ErrorTag | Set an error message tag string |
| Exit |
This method terminates the execution of a script in a regular
fashion with no error messages displayed.
|
| FileRen | Rename a file |
| FileToClipboard | Copy a text file onto the clipboard as text. |
| FilterParmGroup | Controls filtering of specific group during logging. |
| FindFilesVV | Fill a VV with files matching an input file mask. |
| FontLST | List all Windows and geosoft fonts. |
| GenerateGUID(CGXNETCore, String) | Genrates a GUID string (e.g. {4FEDE8BF-CDAB-430A-8026-1CCC0EC0A2EB}) |
| GenerateGUID(CGXNETCore, String, Int32) | Genrates a GUID string (e.g. {4FEDE8BF-CDAB-430A-8026-1CCC0EC0A2EB}) |
| GeosoftConnectAuthenticateAndNavigate | Automatically authenticate and navigate to my.geosoft.com URL |
| GetEntitlementRights | Get the Entitlement Rights |
| GetLoadedMenus | Get the loaded menus. |
| GetPattern | Gets pattern parameters from the parameter block. |
| GetPTMP | Get temporary saves copy of parameter block. |
| GetPublishPathForCentral(CGXNETCore, String, String) | Get cache path to publish datasets to Central |
| GetPublishPathForCentral(CGXNETCore, String, String, Int32) | Get cache path to publish datasets to Central |
| GetREG | Get REG parameters. |
| GetSettingsMETA | Get the settings metadata object. |
| GetWorkspaceREG | Get a copy of the workspace REG; |
| GlobalReset | Reset the global parameters. |
| GlobalSet | Set a global parameter setting. |
| GlobalWrite | Modify the global parameters. |
| GtString(CGXNETCore, String, String, String) | This method returns a string in the parameter block. |
| GtString(CGXNETCore, String, String, String, Int32) | This method returns a string in the parameter block. |
| IAbsoluteFileName(CGXNETCore, String, String) | Convert an abbreviated path name to a full path name. |
| IAbsoluteFileName(CGXNETCore, String, String, Int32) | Convert an abbreviated path name to a full path name. |
| iAssertGX | DLL function argument error assertion |
| IBackupGeoFile(CGXNETCore, String, String) | Backup a Geosoft data file and all associated files to a temporary folder. |
| IBackupGeoFile(CGXNETCore, String, String, Int32) | Backup a Geosoft data file and all associated files to a temporary folder. |
| iCheckArcLicense | Check to see if a ESRI ArcEngine or ArcView license is available |
| iCheckArcLicenseEx(CGXNETCore, String) | Check to see if a ESRI ArcEngine or ArcView license is available, returns type and version of available engine. |
| iCheckArcLicenseEx(CGXNETCore, String, Int32) | Check to see if a ESRI ArcEngine or ArcView license is available, returns type and version of available engine. |
| iCheckArcSDKLicenseEx(CGXNETCore, String) | Check to see if a ESRI ArcGIS Pro SDK and Map SDK license is available, returns type and version of available engine. |
| iCheckArcSDKLicenseEx(CGXNETCore, String, Int32) | Check to see if a ESRI ArcGIS Pro SDK and Map SDK license is available, returns type and version of available engine. |
| iCheckIntrinsic | Check to see if an intrinsic object is licensed |
| iCheckStop |
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.
|
| iClearErrAP | This method is called at to clear all registered errors. |
| iCopyFile | Copy a file. |
| iDatetoLong |
Converts a double date to a value representing total
days elapsed since day 0 of year 0. This uses the
Numerical Receipies Julian function.
|
| iDelay | Idle delay method. |
| iDeleteFile | Delete a file. |
| iDeleteGIFile | Delete the GI file associated with a grid. |
| iDeleteGridFile | Delete a grid file and its associated GI and XML files. |
| iDirExist | Check to see if a directory exists |
| iDisplayQuestion |
Display a YES/NO type question. This method waits
for the user to hit YES or NO.
|
| iDisplayQuestionWithCancel |
Display a YES/NO/CANCEL type question. This method waits
for the user to hit YES or NO or CANCEL.
|
| iDisplayTaskDialogUI | Show a Windows TaskDialog UI (see https://msdn.microsoft.com/en-us/library/windows/desktop/bb760441(v=vs.85).aspx). |
| iExistEnv | Check if setting exists in environment. |
| iExistInt | This method checks to see if a int parameter exists. |
| iExistReal | This method checks to see if a real parameter exists. |
| iExistString | This method checks to see if a string parameter exists. |
| iFileExist | Check to see if a file exists |
| iFileSize | Returns size of a file. |
| iFileWritable |
Check if a file can be created or opened in read-write mode
at a specific location
|
| iFindPath(CGXNETCore, String, Int32, String) | Get full path for a file with Geosoft subdirectory parameter. |
| iFindPath(CGXNETCore, String, Int32, String, Int32) | Get full path for a file with Geosoft subdirectory parameter. |
| iFindPathEx(CGXNETCore, String, Int32, Int32, String) | Get full path for a file. |
| iFindPathEx(CGXNETCore, String, Int32, Int32, String, Int32) | Get full path for a file. |
| IGetDirectory(CGXNETCore, Int32, String) | Get a directory path |
| IGetDirectory(CGXNETCore, Int32, String, Int32) | Get a directory path |
| IGetEnv(CGXNETCore, String, String) | Get an environment setting. |
| IGetEnv(CGXNETCore, String, String, Int32) | Get an environment setting. |
| iGetErrorAP | Get the error number of an error. |
| IGetErrorMessageAP(CGXNETCore, Int32, String) | Return the error message text as a string. |
| IGetErrorMessageAP(CGXNETCore, Int32, String, Int32) | Return the error message text as a string. |
| iGetGeodist |
Gets a global flag that indicates whether we are
running within the geodist library
|
| IGetGeosoftID(CGXNETCore, String) | Get the Geosoft ID (email) if signed in |
| IGetGeosoftID(CGXNETCore, String, Int32) | Get the Geosoft ID (email) if signed in |
| iGetInt | This method returns an int from the parameter block. |
| IGetLicenseClass(CGXNETCore, String) | Get the current application license class. |
| IGetLicenseClass(CGXNETCore, String, Int32) | Get the current application license class. |
| IGetLicensedUser(CGXNETCore, String, String) | Get the licensed user name and Company |
| IGetLicensedUser(CGXNETCore, String, Int32, String, Int32) | Get the licensed user name and Company |
| IGetPath(CGXNETCore, Int32, String) | Get a Geosoft path |
| IGetPath(CGXNETCore, Int32, String, Int32) | Get a Geosoft path |
| IGetProfileName(CGXNETCore, String) | Get the profile name as defined in My Geosoft (or email if not defined) |
| IGetProfileName(CGXNETCore, String, Int32) | Get the profile name as defined in My Geosoft (or email if not defined) |
| IGetProfileURL(CGXNETCore, String) | Get link to my.geosoft.com profile URL |
| IGetProfileURL(CGXNETCore, String, Int32) | Get link to my.geosoft.com profile URL |
| IGetSysInfo(CGXNETCore, Int32, String) | Get system information |
| IGetSysInfo(CGXNETCore, Int32, String, Int32) | Get system information |
| iGetThreadID | Get the ID the current thread. |
| iGetTimer | Return the elapsed time since the established time. |
| iGetTopErrorAP | Get the error number of the last registered error. |
| IGetWindowsDir(CGXNETCore, String) | Get the Windows directory path |
| IGetWindowsDir(CGXNETCore, String, Int32) | Get the Windows directory path |
| iGetYesNo | Check a YES/NO Setting |
| IiGetDotNetGXEntries(CGXNETCore, String, String) |
Get the list of entry points that this assembly has
exposed to Oasis montaj.
|
| IiGetDotNetGXEntries(CGXNETCore, String, String, Int32) |
Get the list of entry points that this assembly has
exposed to Oasis montaj.
|
| IiGlobal(CGXNETCore, String, String) | Get a global parameter setting. |
| IiGlobal(CGXNETCore, String, String, Int32) | Get a global parameter setting. |
| iInteractive | Checks to see if you should run interactively. |
| IiPrompt(CGXNETCore, String, String) | Asks the User to enter a string. |
| IiPrompt(CGXNETCore, String, String, Int32) | Asks the User to enter a string. |
| IiRegistryGetVal(CGXNETCore, Int32, String, String, String) | Get a registry value |
| IiRegistryGetVal(CGXNETCore, Int32, String, String, String, Int32) | Get a registry value |
| iIsSignedIn | Check if signed in via Geosoft Connect |
| iMakeDir | Create a directory. |
| iMakeFileReadonly | Set a file's read-only attribute. |
| iMakeFileWritable | Removes a file's read-only attribute. |
| iNumErrorsAP | Returns the number of registered errors. |
| iOLEAutomation | Call OLE Automation designed to be called from Montaj. |
| iProgState | Return current progress state (On/Off) |
| iRegistryDeleteKey | Delete a registry value |
| iRegistryDeleteVal | Delete a registry value |
| IRelativeFileName(CGXNETCore, String, String) | Convert a file name to a relative abbreviated path name |
| IRelativeFileName(CGXNETCore, String, String, Int32) | Convert a file name to a relative abbreviated path name |
| IReplaceString(CGXNETCore, String, String, String) | Replace "% %" tokens in a string with parameter values |
| IReplaceString(CGXNETCore, String, String, Int32, String) | Replace "% %" tokens in a string with parameter values |
| iRun | Run a command line process. |
| iRunGS | Run a GS. |
| iRunGX(CGXNETCore, String) | Run a GX. |
| iRunGX(CGXNETCore, IWin32Window, String) | Run a GX. |
| iRunPDF | Run a PDF. |
| iRunPython(CGXNETCore, String, String) | Run a Python GX script with initialization information. |
| iRunPython(CGXNETCore, IWin32Window, String, String) | Run a Python GX script with initialization information. |
| iScript | Checks to see if we are running inside OMS (script mode) |
| iScriptRecord | Checks to see if we are in scripting recording mode |
| IsEncryptedString | Checks whether the specified string was encrypted by EncryptString_SYS. |
| iShellExecute | Call Microsoft ShellExecute function (See `MSDN <https://msdn.microsoft.com/en-us/library/windows/desktop/bb762153(v=vs.85).aspx>`_) |
| IShortPathFileName(CGXNETCore, String, String) | Obtains the short path form of a specified input path. |
| IShortPathFileName(CGXNETCore, String, String, Int32) | Obtains the short path form of a specified input path. |
| ITempFileExt(CGXNETCore, String, String) | Generate a unique file name for this extension in the temp directory. |
| ITempFileExt(CGXNETCore, String, String, Int32) | Generate a unique file name for this extension in the temp directory. |
| ITempFileName(CGXNETCore, String, String) | Generate a file name for this file in the temp directory. |
| ITempFileName(CGXNETCore, String, String, Int32) | Generate a file name for this file in the temp directory. |
| iTestingSystemMode | Checks to see if the GX is running in the Geosoft testing system. |
| iTimetoLong | Converts decimal hours to seconds in a day. |
| ITransferPath(CGXNETCore, String, String) | Transfers file path to new file name. |
| ITransferPath(CGXNETCore, String, String, Int32) | Transfers file path to new file name. |
| iValidFileName | Check to see if a file name valid |
| iWriteInDir | Can I create files in this directory ? |
| LoadParm | Reads parameters from a file. |
| LogBackgroundTask | This method logs that a background task was run |
| LogScriptRun | This method logs that a script was run |
| ProgName |
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.
|
| Progress |
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.
|
| ProgUpdate |
This method drives the Progress Bar. It is passed
a percentage and will update the bar to reflect that
percentage.
|
| ProgUpdateL | Updates progress bar based on count and maxcount. |
| PublishDatasetsToCentral(CGXNETCore, String, String, String, String, Int32, Int32, String, String) | Publish datasets to Central |
| PublishDatasetsToCentral(CGXNETCore, String, String, String, String, Int32, Int32, Int32, String, String) | Publish datasets to Central |
| rDate | Returns the current date in decimal years. |
| RegistrySetVal | Set/create a registry value |
| RemoveLineageOutput | Remove an output from the current lineage object |
| RemoveLineageParameter | Remove a parameter in the current lineage object |
| RemoveLineageSource | Remove a source from the current lineage object |
| ResetSettings |
Resets the GX_HELP settings in the geosoft.ini file
after changes have been made.
|
| RestoreGeoFile | Backup a Geosoft data file and all associated files to original location |
| rFileDate | File creation date in decimal years. |
| rFileTime | File creation time in decimal hours. |
| rGetReal | This method returns a real from the parameter block. |
| rLongtoDate |
Converts a value representing total days elapsed since
day 0 of year 0 to a geosoft date. This uses the
Numerical Receipies Julian function.
|
| rLongtoTime | Converts seconds to decimal hours. |
| rMakeDate | Returns the decimal date given the year, month and day. |
| rSecondstoTime | Converts fractional seconds to decimal hours. |
| rTime | Returns the current time in decimal hours. |
| rTimetoSeconds | Converts decimal hours to seconds in a day fractional |
| RunMultiUserScript | Execute a script using multithreaded users |
| rUTCDate | Returns the current UTC date in decimal years. |
| rUTCFileDate | File creation UTC date in decimal years. |
| rUTCFileTime | File creation UTC time in decimal hours. |
| rUTCTime | Returns the current UTC time in decimal hours. |
| SaveLog | Saves the main log file to another file. |
| SaveParm | Writes out one group (or all groups) to a file. |
| SavePTMP | Save a temporary copy of the parameter block. |
| SendGeneralMessage | Send a general information message to all listners |
| SetBackgroundRun | Sets the environment as running in the background. |
| SetCursor | Set the cursor on the display. |
| SetEnv | Set an environment setting. |
| SetInfoLine |
Display a message on the information line at the left
bottom corner of the OAISIS montaj application.
|
| SetInt | This method sets an int in the parameter block. |
| SetInteractive | Sets the interactive mode. |
| SetLineageDescription | Set the description for the current lineage object |
| SetLineageDisplayName | Set the display name for the current lineage object |
| SetLineageName | Set the name for the current lineage object |
| SetLoadedMenus | Load a list of menus |
| SetPattern | Sets pattern parameters in the parameter block. |
| SetReal | This method Sets a real in the parameter block. |
| SetREG | Copy contents of a REG to current parameters. |
| SetServerMessagesAP | Control the server message handling. |
| SetSettingsMETA | Set the settings metadata object. |
| SetString | This method sets a string in the parameter block. |
| SetWorkspaceREG | Set the workspace REG; |
| ShowError | Display any errors to the user. |
| SignIn | Sign in via Geosoft Connect |
| Terminate | DLL error termination |
| WriteDebugLog |
This method writes out information to the output
debugging log file (in temp folder) or output window.
|
See Also