settableparms_t

Contains information about a settable parameter.

Service:NetWare Platform

Structure

  #include <netware.h>
  
  typedef struct
  {
     void            *link;
     void            *value; 
     rtag_t           rTag;
     char            *name;
     uint8_t          type;
     uint8_t          flags;
     uint8_t          category;
     uint8_t          reserved;
     unsigned long    lower_limit;
     unsigned long    upper_limit;
     void             (*callback)( uint32_t oldValue );
     char            *description;
     unsigned short   msg_namenum;
     unsigned short   msg_descnum;
  } settableparms_t;

Fields

link: Initialize this field to NULL and do not modify it; it is reserved for internal use.
value: Points to the memory location where the value for the parameter, either a string or a long, is stored. The size depends upon the type field.
rTag: Contains the handle of the resource tag allocated for this parameter. Use SettableParameterSignature for the signature when creating the resource tag. See AllocateResourceTag.
name: Points to the name of the settable parameter. The parameter name is an ASCII string, which can contain spaces.
type: Specifies the type of data contained in the value field. For possible values, see Section 30.5, Settable Parameter Types.
flags: Specifies when and who can modify the parameter. For possible values, see Section 30.4, Settable Parameter Flags.
category: Specifies the category in which the parameter is listed. To return the name of the category, use ScanSettableParameters.
reserved: Reserved. Set it to 0.
lower_limit: Contains the lowest valid value for the parameter, if appropriate for the parameter type. Otherwise, set it to 0.
upper_limit: Contains the highest valid value for the parameter, if appropriate for the parameter type. Otherwise, set it to 0.
callback: Contains the name of a function to call when the parameter's value is set. This is optional and can be set to NULL.
description: Points to a string which describes the settable parameter.
msg_namenum: Contains the number from the message file that corresponds to the parameter's name. This can be 0 if you are not localizing your messages.
msg_descnum: Contains the number from the message file that corresponds to the parameter's description. This can be 0 if you are not localizing your messages.

Remarks

The DeRegisterSettableParameter and RegisterSettableParameter functions use this structure.