 | CPROJRegisterBackgroundScriptEx Method |
Register an OMS script launched from the project
Namespace:
Geosoft.Desktop.GXNet
Assembly:
geosoft.desktop.gxnet (in geosoft.desktop.gxnet.dll) Version: 2025.1.0.25
Syntaxpublic static void RegisterBackgroundScriptEx(
string name,
string tooltip,
string script,
string log,
string output_log,
string error_log,
int save_log,
CVV output_files,
CLST output_file_types,
string file_to_delete,
string process_id
)
public static void RegisterBackgroundScriptEx(
string name,
string tooltip,
string script,
string log,
string output_log,
string error_log,
int save_log,
CVV output_files,
CLST output_file_types,
string file_to_delete,
string process_id
)
Public Shared Sub RegisterBackgroundScriptEx (
name As String,
tooltip As String,
script As String,
log As String,
output_log As String,
error_log As String,
save_log As Integer,
output_files As CVV,
output_file_types As CLST,
file_to_delete As String,
process_id As String
)
Public Shared Sub RegisterBackgroundScriptEx (
name As String,
tooltip As String,
script As String,
log As String,
output_log As String,
error_log As String,
save_log As Integer,
output_files As CVV,
output_file_types As CLST,
file_to_delete As String,
process_id As String
)
public:
static void RegisterBackgroundScriptEx(
String^ name,
String^ tooltip,
String^ script,
String^ log,
String^ output_log,
String^ error_log,
int save_log,
CVV^ output_files,
CLST^ output_file_types,
String^ file_to_delete,
String^ process_id
)
public:
static void RegisterBackgroundScriptEx(
String^ name,
String^ tooltip,
String^ script,
String^ log,
String^ output_log,
String^ error_log,
int save_log,
CVV^ output_files,
CLST^ output_file_types,
String^ file_to_delete,
String^ process_id
)
static member RegisterBackgroundScriptEx :
name : string *
tooltip : string *
script : string *
log : string *
output_log : string *
error_log : string *
save_log : int *
output_files : CVV *
output_file_types : CLST *
file_to_delete : string *
process_id : string -> unit
static member RegisterBackgroundScriptEx :
name : string *
tooltip : string *
script : string *
log : string *
output_log : string *
error_log : string *
save_log : int *
output_files : CVV *
output_file_types : CLST *
file_to_delete : string *
process_id : string -> unit
Parameters
- name
- Type: SystemString
Name of the job - tooltip
- Type: SystemString
Tooltip text - script
- Type: SystemString
file name of the script. Script should self-delete to indicate process has completed - log
- Type: SystemString
file name of the output log (optional). Will contain info about this script run - output_log
- Type: SystemString
file name of the output progress log (optional). Will contain progress information - error_log
- Type: SystemString
file name of the error log (optional). Will contain info about errors from the run - save_log
- Type: SystemInt32
1 - log file is temporary and deleted on OM close. 0 - do not delete on OM close - output_files
- Type: GeoEngine.Core.GXNetCVV
List of output documents created by the script. - output_file_types
- Type: GeoEngine.Core.GXNetCLST
List of output documents and document type pairs. - file_to_delete
- Type: SystemString
File to delete (optional). Will also delete files with same name and .tmp and .xml extensions - process_id
- Type: SystemString
Process ID - used to check status or kill the process
RemarksAllows the project to track the progress/failure/success of scripts launched in the background
See Also