FFSTQueryConfiguration

FFSTQueryConfiguration queries the FFST configuration parameters.

Syntax
FFSTQueryConfiguration(buffer_length, pConfigParms);

Parameters

 * buffer_length (PULONG) - in/out : Length (in bytes) of the buffer.
 * On input, buffer_length contains the length of the provided buffer.
 * On output, buffer_length contains the total number of bytes that were placed in the buffer. If your buffer is too small, then buffer_length will be set to the required size, and no data will be written to the buffer.


 * pConfigParms (PCONFIGPARMS) - input : Pointer to the buffer where the FFST configuration parameters will be written.

Return Code
FFSTQueryConfiguration returns the following values:
 * rc (APIRET) - returns : Return code.

From FFSTQueryConfiguration to application 1000195     Invalid config user buffer size address 1000200     Invalid config address 1000205     Invalid config revision number 1000210     Invalid config packet size 1000215     Invalid config dump file wrap 1000220     Invalid config dump file directory size 1000225     Invalid config keep dup dump 1000230     Invalid config dump file directory name address 1000235     Invalid config dump file directory name length 1000240     Invalid config no disabled products 1000245     Invalid config disabled products address 1000250     Invalid config vendor tag address 1000255     Invalid config tag address 1000260     Invalid config revision address 1000265     Invalid config message popup

Return codes for file errors during Configuration processing 0x16570     Config file open error 0x16571     Config file search error 0x16572     Config file write error

Return code for an insufficient buffer passed to Configuration 0x1657A     Config insufficient buffer

Return code for invalid dump file directory driver passed to FFSTSetConfiguration. 0x1657B     Invalid config dump file dir drive

Return codes for an invalid drive or path passed to FFSTSetConfiguration. 0x1657C     Invalid drive requested 0x1657D     Invalid path requested

/*-*/ /* Return codes from FFSTProbe, FFSTQueryConfiguration,*/ /* FFSTSetConfiguration or other FFST processing. */ /*-*/ Return codes for shared memory errors 0x16580      Get shared mem error 0x16581      Alloc shared mem error 0x16582      Free shared mem error

Return codes for semaphore errors 0x1658A      Semaphore timeout error 0x1658B      Semaphore open error 0x1658C      Semaphore release error 0x1658D      Semaphore close error 0x1658E      Semaphore request error 0x17111      Semaphore g error

Return codes for dump engine processing which may be posted to the SysLog. 0x16595      Dump hdr file open error 0x16596      Index file open error 0x16597      Dump file open error 0x16598      Memory allocation error 0x16599      Queryfs error 0x1659A      Dump wrap error 0x1659B      Trace rename error 0x17222      Proc dump rename error

Return codes that may be in the SysLog during Worker bringup 0x165A1      Create config semaphore error 0x165A2      Create dump semaphore error 0x165A3      Worker alloc shared mem error 0x165A4      Worker get shared mem error 0x165A5      Create pct semaphore error 0x165A6      File already exists 0x165A7      Specified file not found 0x165A8      Dump validation error 0x165A9      Config memory filled

0x165AA      Worker setconfig error 0x165AB      Worker pipe not created 0x17005      Worker FFST config not okay 0x165AC      Worker mutexsem not released 0x17010      Worker already active 0x17015      Worker initworker failed 0x17050      Worker not active

Remarks
The library FFST.LIB must be linked with object files that use FFSTQueryConfiguration

The packet_revision_number parameter defines if pointers point to ASCII or UniCode character data.

Example Code

 * 1) define INCL_FFST
 * 2) include 

PULONG         buffer_length; PCONFIGPARMS   pConfigParms; APIRET         rc;             /*  Return code. */

rc = FFSTQueryConfiguration(buffer_length, pConfigParms); 

The following example will query for FFST configuration. FFST configuration values are returned in the buffer. You can access individual parameters by using the CONFIGPARMS structure.  #define INCL_FFST #include  #include   APIRET rc; ULONG buffer_length; UniChar config_buffer›300!;

CONFIGPARMS FFSTConfig; PCONFIGPARMS pFFSTConfig  *FFSTConfig;

buffer_length = 300; rc = FFSTQueryConfiguration ( &buffer_length, &config_buffer ); if (rc |= 0)                                   /* If Problem      */ {                                      /* reason          */ printf("FFSTConfigure error: return code = %d",rc); return; } 

Related Functions

 * FFSTSetConfiguration