Spectrum Controls InView Series User Manual page 118

5-12 InView Control and InView Control API
InViewCtrl Methods
RemoveMessage
SingleMessage
User's Manual 0300277-02 Rev. C
Properties Description
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.
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.