Geosoft GXNet API Reference

Geosoft GXNet API Reference

GeoEngine.Core.GXNetX

AddLineageParameter Method

AddLineageSource Method

BreakDate Method

CheckProductUpdates Method

ClearGroup Method

ClearGroupParm Method

ClearLineageParameters Method

ClearLineageSources Method

ClearMenus Method

ClearParm Method

ClipboardToFile Method

ConnectWithCurrentCentralInstance Method

CopyGeoFile Method

CRCFileOffset Method

CreateClipboardRA Method

CreateClipboardWA Method

DATListLST Method

DecryptString Method

DefaultInt Method

DefaultReal Method

DefaultString Method

DeleteDirectory Method

DestroyPTMP Method

DisableGXDebugger Method

DisplayHelp Method

DisplayHelpTopic Method

DisplayInt Method

DisplayMessage Method

DisplayReal Method

DoCommand Method

EMFObjectSize Method

EnableGXDebugger Method

EncryptString Method

ErrorTag Method

FileToClipboard Method

FilterParmGroup Method

FindFilesVV Method

GenerateGUID Method

GeosoftConnectAuthenticateAndNavigate Method

GetEntitlementRights Method

GetLoadedMenus Method

GetPattern Method

GetPublishPathForCentral Method

GetSettingsMETA Method

GetWorkspaceREG Method

GlobalReset Method

GlobalSet Method

GlobalWrite Method

GtString Method

IAbsoluteFileName Method

iAssertGX Method

IBackupGeoFile Method

iCheckArcLicense Method

iCheckArcLicenseEx Method

iCheckArcSDKLicenseEx Method

iCheckIntrinsic Method

iCheckStop Method

iClearErrAP Method

iCopyFile Method

iDatetoLong Method

iDeleteFile Method

iDeleteGIFile Method

iDeleteGridFile Method

iDirExist Method

iDisplayQuestion Method

iDisplayQuestionWithCancel Method

iDisplayTaskDialogUI Method

iExistEnv Method

iExistInt Method

iExistReal Method

iExistString Method

iFileExist Method

iFileSize Method

iFileWritable Method

iFindPath Method

iFindPathEx Method

IGetDirectory Method

iGetErrorAP Method

IGetErrorMessageAP Method

iGetGeodist Method

IGetGeosoftID Method

IGetLicenseClass Method

IGetLicensedUser Method

IGetPath Method

IGetProfileName Method

IGetProfileURL Method

IGetSysInfo Method

iGetThreadID Method

iGetTimer Method

iGetTopErrorAP Method

IGetWindowsDir Method

iGetYesNo Method

IiGetDotNetGXEntries Method

IiGlobal Method

iInteractive Method

IiPrompt Method

IiRegistryGetVal Method

iIsSignedIn Method

iMakeDir Method

iMakeFileReadonly Method

iMakeFileWritable Method

iNumErrorsAP Method

iOLEAutomation Method

iProgState Method

iRegistryDeleteKey Method

iRegistryDeleteVal Method

IRelativeFileName Method

IReplaceString Method

iRunPython Method

iScriptRecord Method

IsEncryptedString Method

iShellExecute Method

IShortPathFileName Method

ITempFileExt Method

ITempFileName Method

iTestingSystemMode Method

iTimetoLong Method

ITransferPath Method

iValidFileName Method

iWriteInDir Method

LoadParm Method

LogBackgroundTask Method

LogScriptRun Method

ProgName Method

Progress Method

ProgUpdate Method

ProgUpdateL Method

PublishDatasetsToCentral Method

RegistrySetVal Method

RemoveLineageOutput Method

RemoveLineageParameter Method

RemoveLineageSource Method

ResetSettings Method

RestoreGeoFile Method

rFileDate Method

rFileTime Method

rGetReal Method

rLongtoDate Method

rLongtoTime Method

rMakeDate Method

rSecondstoTime Method

rTimetoSeconds Method

RunMultiUserScript Method

rUTCDate Method

rUTCFileDate Method

rUTCFileTime Method

rUTCTime Method

SaveParm Method

SavePTMP Method

SendGeneralMessage Method

SetBackgroundRun Method

SetCursor Method

SetInfoLine Method

SetInteractive Method

SetLineageDescription Method

SetLineageDisplayName Method

SetLineageName Method

SetLoadedMenus Method

SetPattern Method

SetServerMessagesAP Method

SetSettingsMETA Method

SetString Method

SetWorkspaceREG Method

ShowError Method

Terminate Method

WriteDebugLog Method

Click or drag to resize

CSYSiAssertGX Method

DLL function argument error assertion

Namespace: GeoEngine.Core.GXNetX
Assembly: geoengine.core.gxnetx (in geoengine.core.gxnetx.dll) Version: 2024.2.0.25

Syntax

public static int iAssertGX(
	CGXNETCore gxNetShared,
	int exp,
	string mod,
	string parm
)

public static int iAssertGX(
	CGXNETCore gxNetShared,
	int exp,
	string mod,
	string parm
)

Public Shared Function iAssertGX ( 
	gxNetShared As CGXNETCore,
	exp As Integer,
	mod As String,
	parm As String
) As Integer

Public Shared Function iAssertGX ( 
	gxNetShared As CGXNETCore,
	exp As Integer,
	mod As String,
	parm As String
) As Integer

public:
static int iAssertGX(
	CGXNETCore^ gxNetShared, 
	int exp, 
	String^ mod, 
	String^ parm
)

public:
static int iAssertGX(
	CGXNETCore^ gxNetShared, 
	int exp, 
	String^ mod, 
	String^ parm
)

static member iAssertGX : 
        gxNetShared : CGXNETCore * 
        exp : int * 
        mod : string * 
        parm : string -> int 


static member iAssertGX : 
        gxNetShared : CGXNETCore * 
        exp : int * 
        mod : string * 
        parm : string -> int

Parameters

gxNetShared: Type: GeoEngine.Core.GXNetXCGXNETCore
A shared CGXNETCore
exp: Type: SystemInt32
Boolean expression (ie. (dB != 0.0) )
mod: Type: SystemString
Module name
parm: Type: SystemString
Argument name

Return Value

Type: Int32
0 assertion passed 1 assertion failed

Remarks

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 iAssertGX_SYS 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 Error_SYS, ErrorTag_SYS and Terminate_SYS functions if you would like to provide a more specific error message.

See Also

Reference

GeoEngine.Core.GXNetX Namespace