Jump to content

FFSTSetConfiguration: Difference between revisions

From EDM2
Created page with "FFSTSetConfiguration sets the FFST configuration parameters. You should use FFSTQueryConfiguration to obtain the current settings before using this function. This allows..."
 
Ak120 (talk | contribs)
mNo edit summary
 
Line 1: Line 1:
FFSTSetConfiguration sets the FFST configuration parameters.  
FFSTSetConfiguration sets the FFST configuration parameters.


You should use [[FFSTQueryConfiguration]] to obtain the current settings before using this function. This allows you to change the desired parameters without affecting others.  
You should use [[FFSTQueryConfiguration]] to obtain the current settings before using this function. This allows you to change the desired parameters without affecting others.


==Syntax==
==Syntax==
Line 7: Line 7:


==Parameters==
==Parameters==
; pConfigParms (PCONFIGPARMS) - input : Pointer to FFST configuration parameters.  
;pConfigParms (PCONFIGPARMS) - input : Pointer to FFST configuration parameters.


==Returns==
==Returns==
; rc (APIRET) - returns: Return code.
;rc (APIRET) - returns: Return code.


FFSTSetConfiguration returns the following values:
FFSTSetConfiguration returns the following values:


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


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


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


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


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


  /*-----------------------------------------------------*/  
  /*-----------------------------------------------------*/  
Line 51: Line 51:
  /*-----------------------------------------------------*/
  /*-----------------------------------------------------*/
Return codes for shared memory errors
Return codes for shared memory errors
        0x16580      Get shared mem error
0x16580      Get shared mem error
        0x16581      Alloc shared mem error
0x16581      Alloc shared mem error
        0x16582      Free shared mem error
0x16582      Free shared mem error


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


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


Return codes that may be in the SysLog during Worker bringup
Return codes that may be in the SysLog during Worker bringup
        0x165a1      Create config semaphore error
0x165a1      Create config semaphore error
        0x165a2      Create dump semaphore error
0x165a2      Create dump semaphore error
        0x165a3      Worker alloc shared mem error
0x165a3      Worker alloc shared mem error
        0x165a4      Worker get shared mem error
0x165a4      Worker get shared mem error
        0x165a5      Create pct semaphore error
0x165a5      Create pct semaphore error
        0x165a6      File already exists
0x165a6      File already exists
        0x165a7      Specified file not found
0x165a7      Specified file not found
        0x165a8      Dump validation error
0x165a8      Dump validation error
        0x165a9      Config memory filled
0x165a9      Config memory filled


        0x165aa      Worker setconfig error
0x165aa      Worker setconfig error
        0x165ab      Worker pipe not created
0x165ab      Worker pipe not created
        0x17005      Worker ffst config not okay
0x17005      Worker ffst config not okay
        0x165ac      Worker mutexsem not released
0x165ac      Worker mutexsem not released
        0x17010      Worker already active
0x17010      Worker already active
        0x17015      Worker initworker failed
0x17015      Worker initworker failed
        0x17050      Worker not active
0x17050      Worker not active


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


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


==Example Code==
==Example Code==

Latest revision as of 19:41, 1 March 2020

FFSTSetConfiguration sets the FFST configuration parameters.

You should use FFSTQueryConfiguration to obtain the current settings before using this function. This allows you to change the desired parameters without affecting others.

Syntax

FFSTSetConfiguration(pConfigParms);

Parameters

pConfigParms (PCONFIGPARMS) - input
Pointer to FFST configuration parameters.

Returns

rc (APIRET) - returns
Return code.

FFSTSetConfiguration returns the following values:

From FFSTSetConfiguration 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 FFSTSetConfiguration

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

Example Code

#define INCL_FFST
#include <os2.h>

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

rc = FFSTSetConfiguration(pConfigParms);

The following example will instruct FFST to stop wrapping dumps. The rest of the parameters are left to their earlier values.

  #define INCL_FFST
  #include <unichar.h>
  #include <os2.h>
  APIRET rc;

  CONFIGPARMS  FFSTConfig;
  PCONFIGPARMS  pFFSTConfig  *FFSTConfig;

  FFSTConfig.dump_file_wrap = FFST_DUMP_WRAP_OFF; /* Set dump wrap to off*/
  /* set rest of the parameters to indicate no change */

  FFSTConfig.dump_file_directory_size = FFST_DUMP_FILE_DIRECTORY_SIZE_NO_CHANGE;
  FFSTConfig.keep_dup_dump = FFST_KEEP_DUP_DUMP_NO_CHANGE;
  FFSTConfig.dump_file_directory_length = FFST_DUMP_FILE_DIERCTORY_LENGTH_NO_CHANGE;
  FFSTConfig.no_of_disabled_products = FFST_NO_OF_PROBE_DISABLED_PRODUCTS_NO_CHANGE;
  FFSTConfig.dump_file_directory = NULL;
  FFSTConfig.PProductData = NULL;

  rc = FFSTSetConfiguration(  pFFSTConfig);
  if (rc |= 0)                                       /* If Problem   */
             {                                       /* reason       */
             printf("FFSTConfigure error: return code = %d",rc);
             return;
             }

Related