[Artwork] / [QisMLib]

QisMCmdCS (.NET Standard 2.0)

A C# interface to QisMLib via it's scripting system

QisMCmd C# API

• Namespace : Artwork.QisMLib

interface QisMCmd

Represents the interface to execute QisMLib commands and script

public interface QisMCmd { ... };

Get_extension_report

Get a report of all the extensions loaded in the system

• Returns the report as a multi-line string

xxxxxxxxxx
string Get_extension_report();

Add_var

Add a string variable to the scripting system

• name is the name to be associated with the variable

• value is the value to be assigned to that variable

• This variable can be referenced in subsequent commands using ((<name>))

xxxxxxxxxx
void Add_var(string name, string value);

Get_var

Get the value associated with a string variable

• name is the name to be associated with the variable

• Returns the value assigned to that variable OR an empty string

xxxxxxxxxx
string Get_var(string name);

Remove_var

Remove a variable from the scripting system if it exists

• name is the name to be associated with the variable

xxxxxxxxxx
void Remove_var(string name);

Run_script

Run a script defined in a text file

• script_file is the path of a valid QisMLib script

• Use List_commands to get a full list of commands and arguments

• See qismlib webpage for detailed reference

• Returns 0 on success. Otherwise use Get_error.. for more information with the returned code

xxxxxxxxxx
int Run_script(string script_file);

Run_command

Run a single QisMLib command

• command is the full command (command-name + args) to be executed

• The command-name and args are each separated by spaces. Args with spaces in them should be enclosed in double-quotes

• Order of args is not important. Commands names and args are case-sensitive

• Use List_commands to get a full list of commands and arguments

• See qismlib webpage for detailed reference

• Returns 0 on success. Otherwise use Get_error.. for more information with the returned code

xxxxxxxxxx
int Run_command(string command);

List_commands

Get a list of commands currently available

• search_str can be used to filter the list. Only commands that contain the specified string token will be returned

• Returns the list as a single multi-line string

• See qismlib webpage for detailed reference

xxxxxxxxxx
string List_commands(string search_str);

Log_msg

• Send a message to the system log

• A newline is not added

xxxxxxxxxx
void Log_msg(string msg);

Log_msg_ln

• Send a message to the system log

• A newline will be added at the end of the message

xxxxxxxxxx
void Log_msg_ln(string msg);

Get_cmd_log

Get the log for the last command as a multi-line string

xxxxxxxxxx
string Get_cmd_log();

Get_error_msg

Get a human-readable description for an error condition represented by ecode

xxxxxxxxxx
string Get_error_msg(int ecode);

Get_error_tag

Get a program-friendly string-code for the error condition represented by ecode

xxxxxxxxxx
string Get_error_tag(int ecode);

Get_error_context

Reserved for future/internal use

xxxxxxxxxx
string Get_error_context(int ecode);

Add_handle

Add an object handle to the scripting system

• type is the handle type

• name is the name to be associated with the variable

• value is the value to be assigned to that variable

• This object can be referenced in subsequent commands using name wherever it's type is allowed as a parameter

xxxxxxxxxx
void Add_handle(string type, string name, IntPtr value);

Get_handle

Get the handle associated with a string variable

• type is the handle type

• name is the name to be associated with the variable

• Returns the handle assigned to that variable OR IntPtr.Zero

xxxxxxxxxx
IntPtr Get_handle(string type, string name);

Remove_handle

Remove a handle from the scripting system if it exists

• type is the handle type

• name is the name to be associated with the variable

xxxxxxxxxx
void Remove_handle(string type, string name);

static class QisMCmdAPI

xxxxxxxxxx
public static class QisMCmdAPI { ... };

Represents the primary interface to use QisMLib from the C#/.NET environment

Init Options

Various optional parameters to be used during initialization

• Specified as a single string of options separated by spaces. Options containing spaces MUST be enclosed in double-quotes

OPT_CFG_S

Specify the config. file to be used

• A config. file contains a list of extensions to be loaded during initialization

• Default: qismlib.cfg in the same location as qismlib64.dll

• Add config={config_file_path} to your string of options

xxxxxxxxxx
public static string OPT_CFG_S = "config=";

OPT_LOG_S

Generate a new log file using QisMLib's logging API

• Add log={log_file_path} to your string of options

xxxxxxxxxx
public static string OPT_LOG_S = "log=";

OPT_LOGA_S

Append to an existing log (or create a new one) using QisMLib's logging API

• Add log+={log_file_path} to your string of options

xxxxxxxxxx
public static string OPT_LOGA_S = "log+=";

OPT_ACSV_S

Specify a vendor string to use trusted (OEM) licensing

• Add acsv={vendor_string} AND acsp={oem_key_file_path} to your string of options

xxxxxxxxxx
public static string OPT_ACSV_S = "acsv=";

OPT_ACSP_S

Specify the key file to use trusted (OEM) licensing

• Add acsv={vendor_string} AND acsp={oem_key_file_path} to your string of options

xxxxxxxxxx
public static string OPT_ACSP_S = "acsp=";

OPT_STDLOG

Enable logging to stdout from within QisMLib

xxxxxxxxxx
public static string OPT_STDLOG = "stdlog";

Get_version

• Get version information for QisMLib as a multi-line string

xxxxxxxxxx
public static string Get_version()

Get_error_msg (QisMCmdAPI)

Get a human-readable description for an error condition represented by ecode

xxxxxxxxxx
public static string Get_error_msg(int ecode)

Get_error_tag (QisMCmdAPI)

Get a program-friendly string-code for the error condition represented by ecode

xxxxxxxxxx
public static string Get_error_tag(int ecode)

Get_error_context (QisMCmdAPI)

Reserved for future/internal use

xxxxxxxxxx
public static string Get_error_context(int ecode)

Set_error

Register an error condition with the QisMLib error system

• tag is the error tag (a string based error code)

• context is reserved for internal use

• msg is a human-readable error message

• Returns an interger that identifies this particular error condition

Get_script_usage

Get usage information from a script file

• script_file is the path of a script that makes use of usage.* commands to provide information

• Returns a multi-line or empty string

Initialize_once

Initialize the QisMLib ONCE during the life of an application

• dll_path is the fully qualified path to qismlib64.dll

• options is a set of optional arguments to be used during initialization

• Returns a handle to the QisMCmd interface on success. In case of error, return is null and ecode is set to the error condition. Use Get_error... for more information about the error

xxxxxxxxxx
public static QisMCmd Initialize_once(string dll_path, string options, ref int ecode)

Close_once

Close QisMLib ONCE during the life of an application

• handle is the handle returned during initialization

xxxxxxxxxx
public static void Close_once(QisMCmd handle)

QisMCmd (.NET Standard 2.0) Licensing

Product name : QisMLib License code : 11003

• Requires ONE license of QisMLib that will be held from initlialization until closing

• Inidividual commands MAY require their own licenses

• See qismlib webpage for detailed reference

QisMCmd (.NET Standard 2.0) Version History

qismcmd_cs_s20 dll v1.1 03-2025

• New API functions to get access to object handles and setting error message

qismcmd_cs_s20 dll v1.0 03-2024

• First cut