18.2.197. PMIx_Device_distance_destruct

PMIx_Device_distance_destruct — Release the contents of a pmix_device_distance_t(5) structure.

18.2.197.1. SYNOPSIS

#include <pmix.h>

void PMIx_Device_distance_destruct(pmix_device_distance_t *d);

18.2.197.1.1. Python Syntax

No Python equivalent

18.2.197.2. INPUT PARAMETERS

d: Pointer to the pmix_device_distance_t(5) structure whose contents are to be released.

18.2.197.3. DESCRIPTION

Release any heap memory referenced by the fields of a pmix_device_distance_t structure. Specifically, the uuid and osname strings are freed if they are non-NULL. The storage for the structure itself is not freed — that remains the responsibility of the caller, since a constructed structure occupies caller-provided storage.

PMIx_Device_distance_destruct is the counterpart to PMIx_Device_distance_construct(3) and should be used on any structure that was initialized with it. To release an array of structures that was allocated by PMIx_Device_distance_create(3), use PMIx_Device_distance_free(3) instead, which both destructs the contents and frees the array storage.

18.2.197.4. RETURN VALUE

PMIx_Device_distance_destruct returns no value (void).