CAPL Script

Get Message I D

This reference collection includes Vector documentation reproduced with permission. Snippets may require configuration-specific symbols and are not all standalone programs. Sources and validation limits.

Syntax

dword getMessageID(char messageName[]); // form 1

dword getMessageID(char messageName[], char dbName[]); // form 2

Function

Finds out the message ID

Parameters

messageName Name of the message.

dbName

Name of the database, needed if the message name is used in more than one database.

Return Values

Message ID, or (dword)-1 if the message is not found

dword id;id = GetMessageID("LightState");

getMessageName