Interpreting Return Codes

State Message

lgo_StateMessage()

Retrieve a human-readable string describing a state.

Syntax
#include "laygomsg.h"

LMessage lgo_StateMessage
    (
         LState    state
    );
statestate code to retrieve a description of
Description

lgo_StateMessage() retrieves a human-readable string describing a state code returned by lgo_State().

Return Values

All calls to lgo_StateMessage() are successful. If the state code is not defined, the message "LayGO state code not defined" is returned.

See Also

lgo_State()

Example
printf("CID %d is in state '%s'\n", cid, lgo_StateMessage(lgo_State(cid)));