Skip to content

Latest commit

 

History

History
35 lines (27 loc) · 1.43 KB

iothubmoduleclient-getsendstatus.md

File metadata and controls

35 lines (27 loc) · 1.43 KB
title titleSuffix description manager author ms.author ms.date ms.service ms.custom ms.topic
IoTHubModuleClient_GetSendStatus function reference | Microsoft Docs
Azure IoT C SDK
This is the function reference page for the IoTHubModuleClient_GetSendStatus() function in the Azure IoT C SDK. This SDK is used with Azure IoT Hub and Azure IoT Hub Device Provisioning Service
timlt
wesmc7777
wesmc
03/25/2022
iot-hub
reference

IoTHubModuleClient_GetSendStatus()

This function returns the current sending status for IoTHubModuleClient.

Syntax

#include "azure-iot-sdk-c/iothub_client/inc/iothub_module_client.h"

IOTHUB_CLIENT_RESULT IoTHubModuleClient_GetSendStatus(
  IOTHUB_MODULE_CLIENT_HANDLE  iotHubModuleClientHandle,
  IOTHUB_CLIENT_STATUS         IoTHubClientStatus
);

Parameters

  • iotHubModuleClientHandle The handle created by a call to the create function.

  • IoTHubClientStatus The sending state is populated at the address pointed at by this parameter. The value will be set to IOTHUB_CLIENT_SEND_STATUS_IDLE if there is currently no item to be sent and IOTHUB_CLIENT_SEND_STATUS_BUSY if there are.

Return Value

IOTHUB_CLIENT_OK upon success or an error code upon failure.