krn.GetNameSpaceParams

This job returns the engine parameters for a specified engine.

1. Input Parameters

Name Type Required Description

Flags

INT

Yes

Currently not supported — pass 0.

NameSpace

STRING

Yes

Short label of the engine (e.g. krn, dms, std)

2. Output Parameters

Name Type Dependency Description

Child

INT

1 = executor was started in a separate process; 0 = in main process

ExecutorPresent

BOOLEAN

1 = executor is present; 0 = not present

Internal

BOOLEAN

1 = internal engine (implemented in kernel); 0 = implemented in executor

Queue

STRING

Name of the queue for the engine

State

INT

Engine status: 0=CREATED; 1=LOADING; 2=LOADED; 3=UNLOADING; 4=UNLOADED

StateText

STRING

Status as text

3. Return Value

(INT): 0 = Job successful, otherwise error code.

4. Notes

  • Which output parameters are returned depends on the specific server installation and configuration and may differ between systems.

  • The available engine labels are returned by krn.EnumNameSpaces.

5. Example

Request with Flags = 0 and NameSpace = dms. Returned output parameters (return value 0):

ExecutorPresent = 1
Internal        = 0
Queue           = dms
State           = 2
StateText       = LOADED

See also: krn.EnumNameSpaces