ATMI C Function Reference
tptypes()
—Routine to determine information about a typed buffer.
#include <atmi.h>
long tptypes(char *ptr, char *type, char *subtype)
tptypes()
takes as its first argument a pointer to a data buffer and returns the type and subtype of that buffer in its second and third arguments, respectively. ptr
must point to a buffer gotten from tpalloc()
. If type
and subtype
are non-NULL, then the function populates the character arrays to which they point with the names of the buffer's type and subtype, respectively. If the names are of their maximum length (8 for type
, 16 for subtype
), the character array is not NULL-terminated. If no subtype exists, then the array pointed to by subtype
will contain a NULL string.
Note that only the first eight bytes of type
and the first 16 bytes of subtype
are populated.
A thread in a multithreaded application may issue a call to tptypes()
while running in any context state, including TPINVALIDCONTEXT
.
Upon success, tptypes()
returns the size of the buffer;
Upon failure, it returns -1 and sets tperrno
to indicate the error condition.
Upon failure, tptypes()
sets tperrno to one of the following values:
Invalid arguments were given (for example, ptr
does not point to a buffer gotten from \% tpalloc()
).