RILMESSAGE (Compact 2013)

Article
11/04/2015

3/26/2014

This structure stores message data.

Syntax

typedef struct rilmessage_tag {
  DWORD cbSize;
  DWORD dwParams;
  RILADDRESS raSvcCtrAddress;
  DWORD dwType;
  DWORD dwFlags;
  UNION {
    struct {
            RILADDRESS raOrigAddress;
            DWORD dwProtocolID;
            RILMSGDCS rmdDataCoding;
            SYSTEMTIME stSCReceiveTime;
            DWORD cbHdrLength;
            DWORD cchMsgLength;
            BYTE rgbHdr[MAXLENGTH_HDR];
            BYTE rgbMsg[MAXLENGTH_MSG];
           } msgInDeliver;
    struct {
            DWORD dwTgtMsgReference;
            RILADDRESS raTgtRecipAddress;
            SYSTEMTIME stTgtSCReceiveTime;
            SYSTEMTIME stTgtDischargeTime;
            DWORD dwTgtDlvStatus;
            DWORD dwProtocolID;
            RILMSGDCS rmdDataCoding;
            DWORD cbHdrLength;
            DWORD cchMsgLength;
            BYTE rgbHdr[MAXLENGTH_HDR];
            BYTE rgbMsg[MAXLENGTH_MSG];
           } msgInStatus;
    struct {
            RILADDRESS raDestAddress;
            DWORD dwProtocolID;
            RILMSGDCS rmdDataCoding;
            DWORD dwVPFormat;
            SYSTEMTIME stVP;
            DWORD cbHdrLength;
            DWORD cchMsgLength;
            BYTE rgbHdr[MAXLENGTH_HDR];
            BYTE rgbMsg[MAXLENGTH_MSG];
           } msgOutSubmit;
    struct {
            DWORD dwProtocolID;
            DWORD dwCommandType;
            DWORD dwTgtMsgReference;
            RILADDRESS raDestAddress;
            DWORD cbCmdLength;
            BYTE rgbCmd[MAXLENGTH_CMD];
           } msgOutCommand;
    struct {
            DWORD dwGeoScope;
            DWORD dwMsgCode;
            DWORD dwUpdateNumber;
            DWORD dwID;
            RILMSGDCS rmdDataCoding;
            DWORD dwTotalPages;
            DWORD dwPageNumber;
            DWORD cchMsgLength;
            BYTE rgbMsg[MAXLENGTH_MSG];
           } msgBcGeneral;
    struct {
            DWORD cchMsgLength;
            BYTE rgbMsg[MAXLENGTH_MSG];
           } msgOutRaw;
    struct {
            RILADDRESS raOrigAddress;
            RILSUBADDRESS rsaOrigSubaddr;
            SYSTEMTIME stSCReceiveTime;
            SYSTEMTIME stValidityPeriodAbs;
            SYSTEMTIME stValidityPeriodRel;
            SYSTEMTIME stDeferredDelTimeAbs;
            SYSTEMTIME stDeferredDelTimeRel;
            DWORD dwNumMsgs;
            RILADDRESS raCallBackNumber; 
            DWORD dwMsgPriority; 
            DWORD dwMsgPrivacy;
            BOOL bUserAckRequest; 
            DWORD dwMsgDisplayMode;
            DWORD dwTeleservice; 
            DWORD dwMsgID;
            DWORD dwMsgLang;
            DWORD dwMsgEncoding;
            DWORD cchMsgLength;
            BYTE rgbMsg[MAXLENGTH_MSG];
           } msgIS637InDeliver;
    struct {
            RILADDRESS raDestAddress;
            RILSUBADDRESS rsaDestSubaddr;
            BOOL bDigit;
            SYSTEMTIME stValidityPeriodAbs;
            SYSTEMTIME stValidityPeriodRel;
            SYSTEMTIME stDeferredDelTimeAbs;
            SYSTEMTIME stDeferredDelTimeRel;
            BOOL bDeliveryAckRequest;
            BOOL bUserAckRequest;
            BOOL bBearerReplyRequest;
            DWORD dwReplySeqNumber;
            DWORD dwMsgDisplayMode;
            RILADDRESS raCallBackNumber;
            DWORD dwMsgPriority;
            DWORD dwMsgPrivacy;
            DWORD dwTeleservice;
            DWORD dwMsgID;
            DWORD dwMsgLang;
            DWORD dwMsgEncoding; 
            DWORD cchMsgLength;  
            BYTE rgbMsg[MAXLENGTH_MSG]; 
           } msgIS637OutSubmit;
    struct { 
            RILADDRESS raOrigAddress;
            RILSUBADDRESS rsaOrigSubaddr;
            SYSTEMTIME stSCReceiveTime;
            DWORD dwCauseCode;
            DWORD dwReplySeqNumber;
            DWORD dwUserResponseCode;
            DWORD dwMsgStatusType;
            DWORD dwMsgID;
            DWORD dwMsgLang;
            DWORD dwMsgEncoding;
            DWORD cchMsgLength;
            BYTE rgbMsg[MAXLENGTH_MSG];
           } msgIS637InStatus;
    struct {
            RILADDRESS raDestAddress;
            RILSUBADDRESS rsaDestSubaddr;
            BOOL bDigit;
            DWORD dwReplySeqNumber;
            DWORD dwUserResponseCode;
            DWORD dwMsgID;
            DWORD dwMsgLang;
            DWORD dwMsgEncoding;
            DWORD cchMsgLength;
            BYTE rgbMsg[MAXLENGTH_MSG];
           } msgIS637OutStatus;
        }
} RILMESSAGE, *LPRILMESSAGE;

Members

cbSize
Structure size, in bytes.

dwParams
Specifies valid parameters. Must be one of the RILMESSAGE GSM Parameter Constants or RILMESSAGE CDMA Parameter Constants.

raSvcCtrAddress
Service center address.

dwType
Specifies the type of message. Must be one of the Message Type Constants.

dwFlags
Specifies message flags. Must be one of the Message Flag Constants.

msgInDeliver
Incoming message delivery indicated by an RIL_MSGTYPE_IN_DELIVER constant.

Members of this structure are used for Global System for Mobile Communications (GSM).

msgInDeliver.raOrigAddress
Originating address.

msgInDeliver.dwProtocolID
Specifies message protocol. Must be one of the Message Protocol Constants.

msgInDeliver.rmdDataCoding
Data coding scheme.

msgInDeliver.stSCReceiveTime
Service code receive time.

msgInDeliver.cbHdrLength
Length of message header, in bytes.

msgInDeliver.cchMsgLength
Length of message body, in bytes.

msgInDeliver.rgbHdr[MAXLENGTH_HDR]
Message header buffer.

msgInDeliver.rgbMsg[MAXLENGTH_MSG]
Message body buffer.

msgInStatus
Incoming status message indicated by an RIL_MSGTYPE_IN_STATUS constant.

Members of this structure are used for GSM.

msgInStatus.dwTgtMsgReference
Specifies the target message reference.

msgInStatus.raTgtRecipAddress
Address of the target recipient.

msgInStatus.stTgtSCReceiveTime
Target recipient receive time.

msgInStatus.stTgtDischargeTime
Target recipient discharge time.

msgInStatus.dwTgtDlvStatus
Specifies target delivery status. Must be one of the Message Delivery Constants.

msgInStatus.dwProtocolID
Specifies message protocol. Must be one of the Message Protocol Constants.

msgInStatus.rmdDataCoding
Data coding scheme.

msgInStatus.cbHdrLength
Length of message header, in bytes.

msgInStatus.cchMsgLength
Length of message body, in bytes.

msgInStatus.rgbHdr[MAXLENGTH_HDR]
Message header buffer.

msgInStatus.rgbMsg[MAXLENGTH_MSG]
Message body buffer.

msgOutSubmit
Outgoing message indicated by an RIL_MSGTYPE_OUT_SUBMIT constant.

Members of this structure are used for GSM.

msgOutSubmit.raDestAddress
Destination address.

msgOutSubmit.dwProtocolID
Specifies message protocol. Must be one of the Message Protocol Constants.

msgOutSubmit.rmdDataCoding
Data coding scheme.

msgOutSubmit.dwVPFormat
Specifies the validity period format. Must be one of the Message Validity Constants.

msgOutSubmit.stVP
Validity period. Must be one of the Message Validity Constants.

msgOutSubmit.cbHdrLength
Length of message header, in bytes.

msgOutSubmit.cchMsgLength
Length of message body, in bytes.

msgOutSubmit.rgbHdr[MAXLENGTH_HDR]
Message header buffer.

msgOutSubmit.rgbMsg[MAXLENGTH_MSG]
Message body buffer.

msgOutCommand
Outgoing command message indicated by an RIL_MSGTYPE_OUT_COMMAND constant.

msgOutCommand.dwProtocolID
Specifies message protocol. Must be one of the Message Protocol Constants.

msgOutCommand.dwCommandType
Specifies the command type. Must be one of the Message Command Constants.

msgOutCommand.dwTgtMsgReference
Specifies the target message reference.

msgOutCommand.raDestAddress
Destination address.

msgOutCommand.cbCmdLength
Length of the command, in bytes.

msgOutCommand.rgbCmd[MAXLENGTH_CMD]
Command buffer.

msgBcGeneral
Broadcast message indicated by an RIL_MSGTYPE_BC_GENERAL constant.

Members of this structure are used for GSM.

msgBcGeneral.dwGeoScope
Specifies the geographic scope of the message. Must be one of the Message Geographic Constants.

msgBcGeneral.dwMsgCode
Specifies the message code.

msgBcGeneral.dwUpdateNumber
Specifies the update number.

msgBcGeneral.dwID
Specifies the identifier.

msgBcGeneral.rmdDataCoding
Data coding scheme.

msgBcGeneral.dwTotalPages
Specifies the total number of pages.

msgBcGeneral.dwPageNumber
Specifies the current page number.

msgBcGeneral.cchMsgLength
Length of message body, in bytes.

msgBcGeneral.rgbMsg[MAXLENGTH_MSG]
Message body buffer.

msgOutRaw
Outgoing raw message as indicated by an RIL_MSGTYPE_OUT_RAW constant.

Members of this structure are used for GSM.

msgOutRaw.cchMsgLength
Length of message body, in bytes.

msgOutRaw.rgbMsg[MAXLENGTH_MSG]
Message body buffer.

msgIS637InDeliver
Incoming message delivery indicated by an RIL_MSGTYPE_IN_IS637DELIVER constant.

Members of this structure are used for Code Division Multiple Access (CDMA).

msgIS637InDeliver.raOrigAddress
Originating address.

msgIS637InDeliver.rsaOrigSubaddr
Origination subaddress.

msgIS637InDeliver.stSCReceiveTime
Service code receive time.

msgIS637InDeliver.stValidityPeriodAbs
Absolute validity period time.

msgIS637InDeliver.stValidityPeriodRel
Relative validity period time.

msgIS637InDeliver.stDeferredDelTimeAbs
Absolute deferred delivery time.

msgIS637InDeliver.stDeferredDelTimeRel
Relative deferred delivery time.

msgIS637InDeliver.dwNumMsgs
Specifies the number of messages on voice mail. This member is valid for voice mail only.

msgIS637InDeliver.raCallBackNumber
Message callback number. The callback number is only valid for paging and text messages.

msgIS637InDeliver.dwMsgPriority
Message priority. Must be one of the Message Priority Class Constants.

msgIS637InDeliver.dwMsgPrivacy
Message privacy level. Must be one of the Message Privacy Class Constants.

msgIS637InDeliver.bUserAckRequest
If this member is set to 0, user acknowledgement is not requested. If this member is set to 1, user acknowledgement is requested.

msgIS637InDeliver.dwMsgDisplayMode
Specifies the message display mode. Must be one of the RIL Message Display Mode Constants.

msgIS637InDeliver.dwTeleservice
Specifies the message teleservice. Must be one of the Message Teleservice Constants. This member is mandatory.

msgIS637InDeliver.dwMsgID
Specifies the message ID (1-65535).

msgIS637InDeliver.dwMsgLang
Specifies the message language.

msgIS637InDeliver.dwMsgEncoding
Specifies the message encoding type. Must be one of the Message Encoding Constants.

msgIS637InDeliver.cchMsgLength
Length of message body, in bytes.

msgIS637InDeliver.rgbMsg[MAXLENGTH_MSG]
Message body buffer.

msgIS637OutSubmit
Outgoing message indicated by an RIL_MSGTYPE_OUT_IS637SUBMIT constant.

CDMA.

msgIS637OutSubmit.raDestAddress
Destination address.

msgIS637OutSubmit.rsaDestSubaddr
Destination subaddress.

msgIS637OutSubmit.bDigit
If this member is set to 0, the RILADDRESS structure is in 4-bit mode. If this member is set to 1, RILADDRESS is in 8-bit mode. The default value for this member should be 1.

msgIS637OutSubmit.stValidityPeriodAbs
Absolute validity period time.

msgIS637OutSubmit.stValidityPeriodRel
Relative validity period time.

msgIS637OutSubmit.stDeferredDelTimeAbs
Absolute deferred delivery time.

msgIS637OutSubmit.stDeferredDelTimeRel
Relative deferred delivery time.

msgIS637OutSubmit.bDeliveryAckRequest
If this member is set to 0, delivery acknowledgement is not requested. If this member is set to 1, delivery acknowledgement is requested.

msgIS637OutSubmit.bUserAckRequest
If this member is set to 0, user acknowledgement is not requested. If this member is set to 1, user acknowledgement is requested.

msgIS637OutSubmit.bBearerReplyRequest
If this member is set to 0, bearer reply is not requested. If this member is set to 1, bearer reply is requested.

msgIS637OutSubmit.dwReplySeqNumber
Specifies the sequence number of the message being replied to, typically the message ID.

msgIS637OutSubmit.dwMsgDisplayMode
Specifies the message display mode. Must be one of the RIL Message Display Mode Constants.

msgIS637OutSubmit.raCallBackNumber
Message callback number. The callback number is only valid for paging and text messages.

msgIS637OutSubmit.dwMsgPriority
Message priority. Must be one of the Message Priority Class Constants.

msgIS637OutSubmit.dwMsgPrivacy
Message privacy level. Must be one of the Message Privacy Class Constants.

msgIS637OutSubmit.dwTeleservice
Specifies the message teleservice. Must be one of the Message Teleservice Constants. This member is mandatory.

msgIS637OutSubmit.dwMsgID
Specifies the message ID (1-65535).

msgIS637OutSubmit.dwMsgLang
Specifies the message language.

msgIS637OutSubmit.dwMsgEncoding
Specifies the message encoding type. Must be one of the Message Encoding Constants.

msgIS637OutSubmit.cchMsgLength
Length of message body, in bytes.

msgIS637OutSubmit.rgbMsg[MAXLENGTH_MSG]
Message body buffer.

msgIS637InStatus
Incoming status message indicated by an RIL_MSGTYPE_IN_IS637STATUS constant.

Members of this structure are used for CDMA.

msgIS637InStatus.raOrigAddress
Originating address.

msgIS637InStatus.rsaOrigSubaddr
Origination subaddress.

msgIS637InStatus.stSCReceiveTime
Service code receive time.

msgIS637InStatus.dwCauseCode
Specifies the cause code.

msgIS637InStatus.dwReplySeqNumber
Specifies the sequence number of the message being replied to, typically the message ID.

msgIS637InStatus.dwUserResponseCode
Specifies the user response code. This member is a carrier-specific code for responding to a user acknowledgement.

msgIS637InStatus.dwMsgStatusType
Specifies the message status type. Must be one of the Message Status Type Constants.

msgIS637InStatus.dwMsgID
Specifies the message ID (1-65535).

msgIS637InStatus.dwMsgLang
Specifies the message language.

msgIS637InStatus.dwMsgEncoding
Specifies the message encoding type. Must be one of the Message Encoding Constants.

msgIS637InStatus.cchMsgLength
Length of message body, in bytes.

msgIS637InStatus.rgbMsg[MAXLENGTH_MSG]
Message body buffer.

msgIS637OutStatus
Outgoing status message indicated by an RIL_MSGTYPE_OUT_IS637STATUS constant.

Members of this structure are used for CDMA.

msgIS637OutStatus.raDestAddress
Destination address.

msgIS637OutStatus.rsaDestSubaddr
Destination subaddress.

msgIS637OutStatus.bDigit
If this member is set to 0, the RILADDRESS structure is in 4-bit mode. If this member is set to 1, RILADDRESS is in 8-bit mode. The default value for this member should be 1.

msgIS637OutStatus.dwReplySeqNumber
Specifies the sequence number of the message being replied to, typically the message ID.

msgIS637OutStatus.dwUserResponseCode
Specifies the user response code. This member is a carrier-specific code for responding to a user acknowledgement.

msgIS637OutStatus.dwMsgID
Specifies the message ID (1-65535).

msgIS637OutStatus.dwMsgLang
Specifies the message language.

msgIS637OutStatus.dwMsgEncoding
Specifies the message encoding type. Must be one of the Message Encoding Constants.

msgIS637OutStatus.cchMsgLength
Length of message body, in bytes.

msgIS637OutStatus.rgbMsg[MAXLENGTH_MSG]
Message body buffer.

Requirements

Header

ril.h

Share via

RILMESSAGE (Compact 2013)

Syntax

Members

Requirements

See Also

Reference

Additional resources