Back to home page

Enduro/X

 
 

    


0001 TPLOGGETBUFREQFILE(3)
0002 =====================
0003 :doctype: manpage
0004 
0005 
0006 NAME
0007 ----
0008 tploggetbufreqfile - Get request file name from UBF buffer
0009 
0010 
0011 SYNOPSIS
0012 --------
0013 #include <atmi.h>
0014 
0015 int tploggetbufreqfile(char *'data', char *'filename', int 'bufsize');
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 Get the request file name from UBF buffer. 'data' is pointer to XATMI buffer allocated by *tpalloc(3)*. 'filename' is output paramter where to store the file name. 'buffsize' is mandatory parameter indicating the output buffer length. Basically this function returns *EX_NREQLOGFILE* field from buffer, if present.
0024 
0025 
0026 RETURN VALUE
0027 ------------
0028 On success, *tploggetbufreqfile()* return zero; on error, -1 is returned, with *tperrno* set to indicate the error.
0029 
0030 ERRORS
0031 ------
0032 Note that *tpstrerror()* returns generic error message plus custom message with debug info from last function call.
0033 
0034 *TPENOENT* Request logging file name not present in UBF buffer or system failure in reading from UBF.
0035 
0036 *TPEINVAL* Not UBF buffer or buffer NULL.
0037 
0038 
0039 EXAMPLE
0040 -------
0041 See *atmitest/test031_logging/atmiclt31.c* for sample code.
0042 
0043 BUGS
0044 ----
0045 Report bugs to support@mavimax.com
0046 
0047 SEE ALSO
0048 --------
0049 *tplogsetreqfile(3)* *tplogsetreqfile_direct(3)* *tplogconfig(3)* *tplogdump(3)* *tplogdumpdiff(3)* *tplog(3)* *ex_devguide(guides)* *ndrxdebug.conf(5)*
0050 
0051 COPYING
0052 -------
0053 (C) Mavimax, Ltd
0054