Phantasmal Site > Phantasmal API > API Listing > get_welcome_message

API Function: get_welcome_message

Summary:

get the text of the login banner

Defined In LPC Object:

/usr/common/sys/configd.c

Prototype:

string get_welcome_message(void)

Can Be Called By:

System, Common, Game

Description:

Get a system welcome message. This is the banner that is sent to a new connection immediately, as soon as the connection is established. The TelnetD will call this function to determine the message to send.

Return Value:

A string with the welcome message.

Errors:

Normally none.

See Also:

set_welcome_message , get_shutdown_message , get_suspended_message