RILMESSAGE
A version of this page is also available for
4/8/2010
This structure stores message data.
Syntax
typedef struct {
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;
Members
- cbSize
Structure size, in bytes.
- dwParams
Specifies valid parameters.
- 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.
- raOrigAddress
Originating address.
- dwProtocolID
Specifies message protocol. Must be one of the message protocol constants.
- rmdDataCoding
Data coding scheme.
- stSCReceiveTime
Service code receive time.
- cbHdrLength
Length of message header, in bytes.
- cchMsgLength
Length of message body, in bytes.
- rgbHdr[MAXLENGTH_HDR]
Message header buffer.
- rgbMsg[MAXLENGTH_MSG]
Message body buffer.
- msgInDeliver
Incoming message delivery indicated by a RIL_MSGTYPE_IN_DELIVER constant.
- dwTgtMsgReference
Specifies the target message reference.
- raTgtRecipAddress
Address of the target recipient.
- stTgtSCReceiveTime
Target recipient receive time.
- stTgtDischargeTime
Target recipient discharge time.
- dwTgtDlvStatus
Specifies target delivery status.
- msgInStatus
Incoming status message indicated by a RIL_MSGTYPE_IN_STATUS constant.
- raDestAddress
Destination address.
- dwVPFormat
Specifies the validity period format.
- stVP
Validity period. Must be one of the message validity constants.
- msgOutSubmit
Outgoing message indicated by a RIL_MSGTYPE_OUT_SUBMIT constant.
- dwCommandType
Specifies the command type.
- cbCmdLength
Length of the command, in bytes.
- rgbCmd[MAXLENGTH_CMD]
Command buffer.
- msgOutCommand
Outgoing command message indicated by a RIL_MSGTYPE_OUT_COMMAND constant.
- dwGeoScope
Specifies the geographic scope of the message. Must be one of the message geographic constants.
- dwMsgCode
Specifies the message code.
- dwUpdateNumber
Specifies the update number.
- dwID
Specifies the identifier.
- dwTotalPages
Specifies the total number of pages.
- dwPageNumber
Specifies the current page number.
- msgBcGeneral
Broadcast message indicated by a RIL_MSGTYPE_BC_GENERAL constant.
- msgOutRaw
Outgoing raw message as indicated by a RIL_MSGTYPE_OUT_RAW constant.
- rsaOrigSubaddr
Origination subaddress.
- stValidityPeriodAbs
Absolute validity period time.
- stValidityPeriodRel
Relative validity period time.
- stDeferredDelTimeAbs
Absolute deferred delivery time.
- stDeferredDelTimeRel
Relative deferred delivery time.
- dwNumMsgs
Specifies the number of messages on voice mail. This member is valid for voice mail only.
- raCallBackNumber
Message callback number. The callback number is only valid for paging and text messages.
- dwMsgPriority
Message priority. Must be one of the message priority class constants.
- dwMsgPrivacy
Message privacy level. Must be one of the message privacy class constants.
- bUserAckRequest
If this member is set to 0, end-user acknowledgement is not requested. If this member is set to 1, end-user acknowledgement is requested.
- dwMsgDisplayMode
Specifies the message display mode. Must be one of the message display mode constants.
- dwTeleservice
Specifies the message teleservice. Must be one of the message teleservice constants. This member is mandatory.
- dwMsgID
Specifies the message ID (1-65535).
- dwMsgLang
Specifies the message language.
- dwMsgEncoding
Specifies the message encoding type. Must be one of the message encoding constants.
- rsaDestSubaddr
Destination address.
- 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.
- bDeliveryAckRequest
If this member is set to 0, delivery acknowledgement is not requested. If this member is set to 1, delivery acknowledgement is requested.
- bBearerReplyRequest
If this member is set to 0, bearer reply is not requested. If this member is set to 1, bearer reply is requested.
- dwReplySeqNumber
Specifies the sequence number of the message being replied to, typically the message ID.
- dwCauseCode
Specifies the cause code.
- dwUserResponseCode
Specifies the user response code. This member is a carrier-specific code for responding to a user acknowledgement.
- dwMsgStatusType
Specifies the message status type. Must be one of the message status type constants.
Requirements
| Header | ril.h |
| Windows Embedded CE | Windows CE .NET 4.2 and later |
See Also
Reference
RIL_SendMsg
RIL_WriteMsg
RILADDRESS
RILMSGDCS
Message Type Constants
RILMESSAGE GSM Parameter Constants
RILMESSAGE CDMA Parameter Constants