IncomingMessagePayloadFormatIndicator Property
Indicates whether the payload is unspecified bytes or UTF-8 Encoded character data.
Syntax
ANSI (Cross Platform) int GetIncomingMessagePayloadFormatIndicator(int iIncomingMessageIndex); Unicode (Windows) INT GetIncomingMessagePayloadFormatIndicator(INT iIncomingMessageIndex);
- (int)incomingMessagePayloadFormatIndicator:(int)incomingMessageIndex;
#define PID_MQTT_INCOMINGMESSAGEPAYLOADFORMATINDICATOR 17 IPWORKSIOT_EXTERNAL void* IPWORKSIOT_CALL IPWorksIoT_MQTT_Get(void *lpObj, int propid, int arridx, int *lpcbVal, int64 *lpllVal); IPWORKSIOT_EXTERNAL int IPWORKSIOT_CALL IPWorksIoT_MQTT_CheckIndex(void *lpObj, int propid, int arridx);
Default Value
0
Remarks
Indicates whether the payload is unspecified bytes or UTF-8 Encoded character data. Possible values are:
Value | Description |
0 | Payload is unspecified bytes |
1 | Payload is UTF-8 Encoded Character Data |
Valid only for MQTT 5.
The IncomingMessageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the IncomingMessageCount property.
This property is read-only and not available at design time.
Data Type
Integer