Syntax
MarqueeMessageClear ( Project, Process, Device, RefID )
Description
Clears a marquee message from the remote project.
This function returns an Integer that represents the status of the function.
Statuses
|
MARQ_SUCCESS |
The message was successfully cleared. |
|
MARQ_NOCOMM_PROJECT |
A problem was experienced communicating with the remote project. |
|
MARQ_BAD_DEVICE |
You have specified an invalid device. |
|
MARQ_CANT_DELETE |
The remote marquee process was unable to delete the message you specified from its queue. |
|
MARQ_EMPTY_PROJECT_ID |
You specified an empty project ID. |
|
MARQ_EMPTY_SERVICE_ID |
You specified an empty service ID. |
|
MARQ_EMPTY_DEVICE_ID |
You specified an empty device ID. |
|
MARQ_EMPTY_REF_ID |
You specified an empty reference ID. |
|
MARQ_INVALID_SERVICE_ID |
You specified an invalid service ID. |
Comments
The MarqueeMessageClear function requires the following parameters.
Parameter Description
|
Project |
The name of the remote CIMPLICITY project where the marquee message should be cleared. |
|
Process |
The Service ID of the marquee resident process on the remote CIMPLICITY project where the marquee messages should be cleared. |
|
Device |
The name of the configured marquee device controlled by the marquee resident process on the remote CIMPLICITY project where the marquee message should be cleared. |
|
RefID |
The Reference ID to be associated with this text. This must be the same Reference ID used by the MarqueeMessageGenerate function. |
|
|
Extensions to the Basic Control Engine. |
