Back to home page

Enduro/X

 
 

    


0001 TPTYPES(3)
0002 ==========
0003 :doctype: manpage
0004 
0005 
0006 NAME
0007 ----
0008 tptypes - Return type information from given buffer pointer
0009 
0010 
0011 SYNOPSIS
0012 --------
0013 #include <atmi.h>
0014 
0015 long tptypes(char *'ptr', char *'type', char *'subtype');
0016 
0017 For XATMI client link with '-latmiclt -latmi -lubf -lnstd -lpthread -lrt -lm'
0018 
0019 For XATMI server link with '-latmisrv|-latmisrvnomain|-latmisrvinteg -latmi -lubf -lnstd -lpthread -lrt -lm'
0020 
0021 DESCRIPTION
0022 -----------
0023 Function returns type information from given buffer pointer in 'ptr'. If paramter 'type' is not NULL, then in case of success buffer type is coppied to. If buffer sub-type is used and argument 'subtype' is not NULL, then sub-type code is coppied to.
0024 
0025 RETURN VALUE
0026 ------------
0027 On success, *tptypes()* return buffer allocated length; on error, -1 is returned, with *tperrno* set to indicate the error.
0028 
0029 
0030 ERRORS
0031 ------
0032 Note that *tpstrerror()* returns generic error message plus custom message with debug info from last function call.
0033 
0034 *TPEINVAL* Enduro/X is not configured or buffer pointer is NULL or not allocated by *tpalloc()*.
0035 
0036 *TPESYSTEM* System failure occurred during serving. See logs i.e. user log, or debugs for more info.
0037 
0038 *TPEOS* System failure occurred during serving. See logs i.e. user log, or debugs for more info.
0039 
0040 
0041 EXAMPLE
0042 -------
0043 See *atmitest/test017_srvthread/atmisv17.c* for sample code.
0044 
0045 BUGS
0046 ----
0047 Report bugs to support@mavimax.com
0048 
0049 SEE ALSO
0050 --------
0051 *tpalloc(3)*
0052 
0053 COPYING
0054 -------
0055 (C) Mavimax, Ltd
0056