Function iox_runtime_get_instance_name

Function Documentation

uint64_t iox_runtime_get_instance_name(char *const name, const uint64_t nameLength)

retrieves the instance-name of the current posh runtime instance

Parameters:
  • name[in] char pointer to preallocated memory

  • nameLength[in] size of the preallocated memory.

Returns:

The length of the instance-name. If the instance-name is longer then nameLength a number greater nameLength is returned and the instance-name, truncated to nameLength, is written into the memory location of name. If name is a nullptr, 0 will be returned.