AzureIoTHubGetMsgId

AzureIoTHubGetMsgId returns the ID of the specified index value of an Azure IoT Hub connection. See Notes for more information.

Syntax

AzureIoTHubGetMsgId(strAlias, nIndex)

strAlias

The name of the Azure IoT Hub connection that you want to use. The connection can be created either during project development (in the Project ExplorerTasks tab Internet of Things folder) or during project run time (by calling the AzureIoTHubOpen function).

nIndex

Zero-based index of the message.

Return value

If successful, this function returns the message ID (a positive integer).

If unsuccessful, this function returns one of the following negative integer values:

Notes

Messages are kept in the Gateway ("alive" in the IoT Hub queue) for up to 10 minutes before they are deleted from the queue. (The settings for messages are currently configured in the IoT Hub settings.) The Gateway has a limit of 100 messages per connection; older messages (in terms of creation time) will be deleted to make room for newer messages.

This function requires an open IoT Hub connection. The connection can be created either during project development (in the Project ExplorerTasks tab Internet of Things folder) or during project run time (by calling the AzureIoTHubOpen or AzureIoTHubSendMsg functions).

Examples

As used in a Math worksheet: