Quantum Resource Management Interface (QRMI) C API
Loading...
Searching...
No Matches
Quantum Resource Metadata

Functions

QrmiReturnCode qrmi_resource_metadata_free (QrmiResourceMetadata *ptr)
char * qrmi_resource_metadata_value (QrmiResourceMetadata *metadata, const char *key)
QrmiReturnCode qrmi_resource_metadata_keys (QrmiResourceMetadata *metadata, size_t *num_keys, char **key_names[])

Detailed Description

Functions used when accessing Quantum resource metadata from the QRMI C API.

Function Documentation

◆ qrmi_resource_metadata_free()

QrmiReturnCode qrmi_resource_metadata_free ( QrmiResourceMetadata * ptr)

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

QrmiResourceMetadata *metadata = NULL;
QrmiReturnCode rc = qrmi_resource_metadata(qrmi, &metadata);
if (retval == QRMI_RETURN_CODE_SUCCESS) {
}
QrmiReturnCode qrmi_resource_metadata(QrmiQuantumResource *qrmi, QrmiResourceMetadata **outp)
QrmiReturnCode qrmi_resource_metadata_free(QrmiResourceMetadata *ptr)
QrmiReturnCode
Definition qrmi.h:55
@ QRMI_RETURN_CODE_SUCCESS
Definition qrmi.h:59
struct QrmiResourceMetadata QrmiResourceMetadata
Definition qrmi.h:232
Parameters
(ptr)[in] A QrmiResourceMetadata handle to be free
Returns
QrmiReturnCode::QRMI_RETURN_CODE_SUCCESS if succeeded.
Version
0.6.0

◆ qrmi_resource_metadata_keys()

QrmiReturnCode qrmi_resource_metadata_keys ( QrmiResourceMetadata * metadata,
size_t * num_keys,
char ** key_names[] )

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;
QrmiReturnCode rc = qrmi_resource_metadata_keys(metadata, &num_keys, &metadata_keys);
for (int i = 0; i < num_keys; i++) {
printf("%s\n", metadata_keys[i]);
}
qrmi_string_array_free(num_keys, metadata_keys);
}
QrmiReturnCode qrmi_resource_metadata_keys(QrmiResourceMetadata *metadata, size_t *num_keys, char **key_names[])
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()

char * qrmi_resource_metadata_value ( QrmiResourceMetadata * metadata,
const char * key )

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

char *value = qrmi_resource_metadata_value(metadata, "backend_name");
printf("metadata value=[%s]\n", value);
char * qrmi_resource_metadata_value(QrmiResourceMetadata *metadata, const char *key)
QrmiReturnCode qrmi_string_free(char *ptr)
Parameters
(metadata)[in] A QrmiResourceMetadata handle
(key)[in] metadata key name
Returns
metadata value if succeeded. Must call qrmi_string_free() to free if no longer used.
Version
0.6.0