4.10.25 nxo_name
Keywords: onyx

Next: 4.10.26 nxo_no Up: 4.10 Classes Previous: 4.10.24 nxo_mutex Contents Index
Subsections

- 4.10.25.1 API

##
4.10.25 nxo_name

The nxo_name class is a subclass of the nxo class.

### 4.10.25.1 API

void nxo_name_new(cw_nxo_t *a_nxo, const char *a_str, uint32_t a_len, bool a_is_static):

  Input(s):
    a_nxo:
      Pointer to a name nxo.
    a_str:
      Pointer to a character string (not required to be '\0' terminated).
    a_len:
      Length in bytes of a_str.
    a_is_static:
      false:
        a_str may be modified or deallocated during the lifetime of the program.
      true:
        a_str will not be modified for the lifetime of the program.
  Output(s):
    None.
  Exception(s):
    CW_ONYXX_OOM.
  Description:
    Constructor.

const char * nxo_name_str_get(const cw_nxo_t *a_nxo):

  Input(s):
    a_nxo:
      Pointer to a name nxo.
  Output(s):
    retval:
      Pointer to a string that represents a_nxo.
  Exception(s):
    None.
  Description:
    Return a pointer to a string that represents a_nxo.

uint32_t nxo_name_len_get(const cw_nxo_t *a_nxo):

  Input(s):
    a_nxo:
      Pointer to a name nxo.
  Output(s):
    retval:
      Length in bytes of the name associated with a_nxo.
  Exception(s):
    None.
  Description:
    Return the length in bytes of the name associated with a_nxo.

Next: 4.10.26 nxo_no Up: 4.10 Classes Previous: 4.10.24 nxo_mutex Contents Index