sk_getMsgName()

 

Use the sk_getMsgName() function to return the name of the given message to your application. This function is also available as skts_getMsgName().

Description

This function call returns the name of a message to the application.

Syntax

int sk_getMsgName(MsgStruct *);

Threadsafe Syntax

int skts_getMsgName(MsgStruct *);

Parameters

The function parameters are shown in the table below.

Argument

Description

MsgStruct *

Pointer to a generic C Structure representing a message.

Return Values

Possible return values for this function:

SK_LOST_LLC

This return value indicates that your application lost contact with the LLC.

"Message"

If the message is a known Toolkit message or EXS API message, the function returns the message name.

Unknown TK Tag

The message is an unknown Toolkit message, returned with the message tag.

Unknown Tag

The message is an unknown EXS API message, returned with the message tag.

AdminMessage

The message is an AdminMessage.

DummyMessage

If the message is a DummyMessage.