User Manual Manual

Publication 2706-UM016D-EN-P - March 2006
InView Control and InView Control API 5-11
RemoveMessage Syntax HRESULT RemoveMessage
(short nMessageNumber)
Parameters nMessageNumber
The number of the message to be removed
from the queue of running messages.
Return Value S_OK - Success
E_FAIL - Failure
Description This method is used to trigger a message to
stop running on the display. The remove
message command will be sent to the
display address set by the DisplayAddress
property. DisplayAddress should be set
before calling this method.
SingleMessage Syntax HRESULT SingleMessage
(short nMessageNumber)
Parameters nMessageNumber
The number of the sole message to be
added to the queue of running messages.
Return Value S_OK - Success
E_FAIL - Failure
Description This method is used to trigger a single
message to run on the display. Any
messages currently running on the display
will be removed. The message to trigger
must be downloaded to the display before it
can be triggered. The single message
command will be sent to the display address
set by the DisplayAddress property.
DisplayAddress should be set before calling
this method.
UpdateVariable Syntax HRESULT UpdateVariable
(short nVariable, long nValue)
Parameters nVariable
The variable number to update.
Valid values are 0 … 99.
nValue
The new value for the variable. The display
is limited to 16-bit numbers, which can be
signed or unsigned.
Return Value S_OK - Success
E_FAIL - Failure
Description This method is used to update a variable in
the display. If the variable is embedded in a
running message, the new value will be
shown. The update variable command will
be sent to the display address set by the
DisplayAddress property. DisplayAddress
should be set before calling this method.
Methods
InViewCtrl Methods Properties Description