Annotation Glossary: St Reference Manual

# Annotation Glossary

### E

element-type

  Generics and defining elements of containers and arrays.

### I

inout

  Parameter for input and for returning results. Default is transfer full.

### N

nullable

  NULL may be passed as the value in, out, in-out; or as a return value.

### O

optional

  NULL may be passed instead of a pointer to a location.

out

  Parameter for returning results. Default is transfer full.

out caller-allocates

  Out parameter, where caller must allocate storage.

### S

scope async

  The callback is valid until first called.

skip

  Exposed in C code, not necessarily available in other languages.

### T

transfer container

  Free data container after the code is done.

transfer full

  Free data after the code is done.

transfer none

  Don't free data after the code is done.

### U

Unstable

  Unstable interfaces are experimental or transitional. They are typically used to give outside developers early access to new or rapidly changing technology, or to provide an interim solution to a problem where a more general solution is anticipated. No claims are made about either source or binary compatibility from one minor release to the next. The Unstable interface level is a warning that these interfaces are subject to change without warning and should not be used in unbundled products. Given such caveats, customer impact need not be a factor when considering incompatible changes to an Unstable interface in a major or minor release. Nonetheless, when such changes are introduced, the changes should still be mentioned in the release notes for the affected release.