Functions used when accessing Quantum resource metadata from the QRMI C API.
◆ qrmi_resource_metadata_free()
Frees the memory space pointed to by ptr, which must have been returned by a previous call to qrmi_resource_metadata(). Otherwise, or if ptr has already been freed, segmentation fault occurs. If ptr is NULL, returns < 0.
Safety
Example
}
QrmiReturnCode qrmi_resource_metadata(QrmiQuantumResource *qrmi, QrmiResourceMetadata **outp)
QrmiReturnCode
Definition qrmi.h:55
@ QRMI_RETURN_CODE_SUCCESS
Definition qrmi.h:59
struct QrmiResourceMetadata QrmiResourceMetadata
Definition qrmi.h:232
- Parameters
-
- Returns
- QrmiReturnCode::QRMI_RETURN_CODE_SUCCESS if succeeded.
- Version
- 0.6.0
◆ qrmi_resource_metadata_keys()
Returns a list of the metadata keys
Safety
- metadata must have been returned by a previous call to qrmi_resource_metadata().
- num_keys and key_names must be non-null.
Example
size_t num_keys = 0;
char **metadata_keys = NULL;
for (int i = 0; i < num_keys; i++) {
printf("%s\n", metadata_keys[i]);
}
}
QrmiReturnCode qrmi_string_array_free(size_t size, char *array[])
- Parameters
-
| (metadata) | [in] A QrmiResourceMetadata handle |
| (num_keys) | [out] number of keys available in the metadata |
| (key_names) | [out] A list of metadata key names if succeeded. Must call qrmi_string_array_free() to free if no longer used. |
- Returns
- QrmiReturnCode::QRMI_RETURN_CODE_SUCCESS if succeeded.
◆ qrmi_resource_metadata_value()
Returns metadata value of the specified key
Safety
- metadata must have been returned by a previous call to qrmi_resource_metadata().
- The memory pointed to by key must contain a valid nul terminator.
- The nul terminator must be within isize::MAX from key.
Example
printf("metadata value=[%s]\n", value);
QrmiReturnCode qrmi_string_free(char *ptr)
- Parameters
-
- Returns
- metadata value if succeeded. Must call qrmi_string_free() to free if no longer used.
- Version
- 0.6.0