| CSYSiAssertGX Method |
DLL function argument error assertion
Available since Oasis montaj version: 5.0.0
License: Available to anyone.
Namespace: GeoEngine.Core.GXNetAssembly: geoengine.core.gxnet (in geoengine.core.gxnet.dll)
Notes
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.
Syntax public static int iAssertGX(
int i1,
string str2,
string str3
)
Public Shared Function iAssertGX (
i1 As Integer,
str2 As String,
str3 As String
) As Integer
public:
static int iAssertGX(
int i1,
String^ str2,
String^ str3
)
static member iAssertGX :
i1 : int *
str2 : string *
str3 : string -> int
Parameters
- i1
- Type: SystemInt32
boolean expression (ie. (dB != 0.0) ) - str2
- Type: SystemString
module name - str3
- Type: SystemString
argument name
Return Value
Type:
Int32
0 assertion passed
1 assertion failed
See Also