pips_guid_tostring()

Updated: May 06, 2022

Convert a GUID to a string

Synopsis:

#include <pips/pips.h>
int pips_guid_tostring(const pips_guid_t *const self,
                       pips_guid_str_t *buffer)

Arguments:

self
A pointer to a GUID instance to convert to a string
buffer
A pointer to a GUID string buffer into which the current GUID will be written

Library:

pips-client

Description:

This function encodes (formats) the current GUID as a hexadecimal string and stores the result in the given GUID string buffer. This function is a shortcut that saves clients from having to call pips_guid_format(), which has an extra parameter.

Returns:

On success, the number of characters written to the string buffer; this should almost always be 32. On error, a negative value (errno is set).

Errors:

  • EINVAL: The GUID or the string buffer is invalid.