Syntax
MarqueeMessageGenerate ( Project, Process, Device, Message [, RefID] )
Description
Generates a marquee messages from your CIMPLICITY project and sends it to the remote project.
Returns an Integerthat represents the status of the function.
Statuses
|
MARQ_SUCCESS |
The message was successfully generated. |
|
MARQ_NOCOMM_PROJECT |
A problem was experienced communicating with the remote project. |
|
MARQ_BAD_DEVICE |
You have specified an invalid device. |
|
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 MarqueeMessageGenerate function requires the following parameters:
Parameter Description
|
Project |
The name of the remote CIMPLICITY project to which the marquee message should be sent. |
|
Process |
The Service ID of the marquee resident process on the remote CIMPLICITY project to which the marquee messages should be sent. |
|
Device |
The name of the configured marquee device controlled by the marquee resident process on the remote CIMPLICITY project to which the marquee message should be sent. |
|
Message |
The text to be displayed. |
|
RefID |
An optional Reference ID to be associated with this text. If you specify a RefID, then the message you send is appended to the end of the marquee message queue of the remote process, and you can use the MarqueeMessageClear function to delete the message. If you do not specify a RefID, then the message you send is displayed immediately by the remote process, it is not added to its queue, and it is never displayed again. This is useful if you need to display a marquee message only once and immediately. |
|
|
Extensions to the Basic Control Engine. |
