GetMessageStatus

Description

Retrieves information about an SMS message sent during the current session.

Applies to

SMSSession objects

Syntax

objectname.GetMessageStatus ( smsmsg )

Argument

Description

objectname

The name of the SMSSession object

smsmsg

An SMS message structure returned by reference that contains information about the message

Returns

Integer. Returns 1 for success and a negative value if an error occurs.

Usage

The GetMessageStatus function retrieves an SMSMessage structure that contains information about the message’s ID, options, validity period, text content if any, and status.

Examples

Example 1

The following example retrieves information about a message in the global variable g_smsMsg, stores the value of its Status property in the msgStat SMSMsgStatus variable, and writes the value of msgStat to a single line edit box:

// Global variables: 
// SMSSession g_smsSess
// SMSMessage g_smsMsg

SMSMsgStatus msgStat
integer li_ret

li_ret = g_smsSess.GetMessageStatus(g_smsMsg)
msgStat = g_smsMsg.Status
sle_status.text = "Message status: " + String(msgStat)

See also