Jobs_UpdateMsg

size_t Jobs_UpdateMsg( JobCurrentStatus_t status,
                       const char * expectedVersion,
                       size_t expectedVersionLength,
                       char * buffer,
                       size_t bufferSize );

Populate a message string for an UpdateJobExecution request.

Parameters

status	Current status of the job
expectedVersion	The version that is expected
expectedVersionLength	The length of the expectedVersion string
buffer	The buffer to be written to
bufferSize	the size of the buffer

Returns

0 if write to buffer fails

messageLength if the write is successful

Example

// The Following Example shows usage of the Jobs_UpdateMsg API to
// generate a message string for the UpdateJobExecution API
// of the AWS IoT Jobs Service
const char * expectedVersion = "2";
size_t expectedVersionLength = ( sizeof(expectedVersion ) - 1U );
JobCurrentStatus_t status = Succeeded;
char messageBuffer[ UPDATE_JOB_MSG_LENGTH ]  = {0};
size_t messageLength = 0U;
 
messageLength = Jobs_UpdateMsg( status,
                                expectedVersion,
                                expectedVersionLength,
                                messageBuffer,
                                UPDATE_JOB_MSG_LENGTH );
 
if (messageBufferLength > 0 )
{
    // The message string of length, messageLength, has been
    // generated in the buffer, messageBuffer, for the UpdateJobExecution API
    // Publish this message to the topic generated by Jobs_Update using an
    // MQTT client of your choice.
}