ScanSetableParameters

Syntax

  #include <nwadv.h>  
   
  LONG ScanSetableParameters  (  
     LONG    scanCategory,   
     LONG   *scanSequence,   
     BYTE   *rParameterName,   
     LONG   *rType,   
     LONG   *rFlags,   
     LONG   *rCategory,   
     void   *rParameterDescription,   
     void   *rCurrentValue,   
     LONG   *rLowerLimit,   
     LONG   *rUpperLimit); 
  

Parameters

scanCategory

(IN) Specifies the category for which to return setable parameter information.

scanSequence

(IN/OUT) Points to this parameter is used for calling this function iteratively. On the first call, this parameter should be set to 0. On subsequent calls, use the value returned in this parameter. When all information has been returned, this function returns -1 (unsuccessful).

rParameterName

(IN/OUT) Points to or receives the name of a setable parameter (an ASCIIZ string). (Input if scanCategory is -2 or -5.)

rType

(OUT) Points to the type of the setable parameter.

rFlags

(OUT) Points to the setable parameter flags.

rCategory

(OUT) Points to the setable parameter category.

rParameterDescription

(OUT) Points to the description of a setable parameter (an ASCIIZ string).

rCurrentValue

(OUT) Points to the value (a number or string, depending on rType) to which the setable parameter is currently set. Receives the size of the current value, rather than the value itself if scanCategory is set to -2.

rLowerLimit

(OUT) Points to the lower limit of the setable parameter.

rUpperLimit

(IN/OUT) Points to the upper limit of the setable parameter. (Input if scanCategory is -4 or -5; must be at least 512 bytes.)

Return Values

This function returns 0 if successful, or a negative value if unsuccessful.

Remarks

This function returns information about setable parameters. A setable parameter is a NetWare OS parameter that can be set using the SET console command.

The scanCategory parameter defines what information the function returns. This parameter can have one of the following values:

If scanCategory is -4 or -5, this function returns information into a buffer pointed to by rCurrentValue. The buffer must be at least 512 bytes. Novell does not provide a parser for this buffer, which is filled in the following order:

  long          paramType 
  long          category 
  long          flags 
  string        parameterName  /* Null terminated string */ 
  string/long  parameterValue /*Either long or null-terminated string */
  

The paramType segment contains a value that corresponds to those of the rType parameter, explained below.

The category segment contains a value that corresponds to those of the rCategory parameter, explained below.

The flags segment contains a value that corresponds to those of the rFlags parameter, explained below.

The parameterName segment contains a string that names the parameter, as explained about the rParameterName parameter below.

The parameterValue segment contains either a long or a string, depending upon the parameter type as returned in the paramType segment.

The rParameterName parameter is the name of the setable parameter, such as "Cache Buffer Size".

The rType parameter receives the type of the setable parameter:

The "trigger" type is a level at which an event would happen. The "Minimum File Cache Buffer Report Threshold" is an example of a trigger type.

The rFlags parameter defines properties of the parameter, such as when it can be set:

The rCategory parameter can be one of the following categories:

See Also

GetSetableParameterValue, SetSetableParameterValue, "SET" in Supervising the Network