beautypg.com

Object action – Visara Master Console Center Scripting Guide User Manual

Page 27

background image

Chapter 2 Advanced Topics

Scripting Guide

27

Object Action

The status of objects can change with time. You can use object actions to
wait for those changes.

Note: These actions are used with the OBJEXEC command.

The following table describes object actions, descriptions of those object
actions, parameters (described after the table), and the return value of
each object action.

Object Action
Type

Description Parameters

Return

Value

WAIT

The system waits until
a field value changes

on the specified object.

Timeout parameter is
optional (if not set, it

defaults to zero) and

specifies the number of
seconds to wait before

coming out of wait

state. Zero means
wait forever.

%Timeout

0 if successful.
Negative on

error.

WAITCHILD

The system waits until
a field value changes on

the child of the

specified object. For
example, a script on an

OS can pause until a

change is detected in
the TaskMan fields

(SW class—the child

class of the OS class)
for that OS. The

return value is the

Object ID of the object
that changed (the task

that had a field
change).

%Timeout Object

ID

of

object that

changed.

WAITQUEUE

The same as WAIT,
except queues all

change messages so as

not to miss any (for
sequentially

processing all field

change notices). For
example, with

WAITQUEUE, if the

script receives a
wakeup notice and the

written script routine

%Timeout 0

if

successful.

Negative on

error.