![]() Session Class Properties |
![]() DEVELOPER |
![]() |
Type |
Name |
Read (R) Write (W) |
Definition |
Long |
SystemHandle |
W |
This is the system-session-id for the Kernel Manager; it is required to be passed in to the Open function to associate the session as pertaining to a particular System. |
Long |
SessionHandle |
R |
This Handle is set as a kernel-session-id for the connection, and is a result of a successful Open call. This value is passed to other session related functions within the P4API. |
String |
Environment |
W |
The name of the required kernel environment. |
String |
OperatorId |
W |
The PROIV operator-id to use by the kernel. |
String |
OperatorPassword |
W |
The password to use for PROIV operator-id |
String |
CoDiv |
W |
The PROIV Company/Division code to use by the kernel. |
String |
TaskName |
W |
The name of the required PROIV Task. |
Bool |
EnablePrinterEvents |
W |
This parameter is set to capture printer output. A PrintLine event is fired by the OCX control for each output. The output format is specified elsewhere. |
Long |
ParamListCount |
W |
Number of parameters specified in the ParamList property. |
String |
ParamList |
W |
The Delimiter-Separated List-Stream format parameters Input to the task. |
Long |
BufSize |
W |
The size of the buffer used when the ExecTask method is called. It must be large enough to contain the largest input or output parameter list. This defaults to 1K. |
String |
EnvList |
W |
The Delimiter-Separated List-Stream format Environmental parameters Input to the task. |
Long |
EnvListCount |
W |
Number of parameters specified in the EnvList property. |
String |
EnvListOut |
R |
Environment Parameters List output as a result of the Exec Task Call. |
String |
ParamListOut |
R |
The Parameter List output as a result of the ExecTask Call. |
Long |
ParamCountOut |
R |
The number of parameters which are output as a result of the ExecTask operation. |
Long |
EnvCountOut |
R |
The number of Environmental parameters which are output as a result of the ExecTask operation. |
OCX Session Class Properties
Topic ID: 540140