BSUL::TParameterDetails Struct Reference

Detailed Description

This structure defines the format for storing information for an individual message parameter.

iType - This defines the parameter type and is used by the CMessageParameterBase class to instantiate the appropriate derived class via the KParameterFactoryFunctions factory lookup table.

iMin, iMax - These are two constraints that are used in the ValidateL method of a class derived from CMessageParameter to validate the message as required by that parameter. The constraints that are used depend on the type as follows: EParamInt: -iMin = Minimum int value accepted -iMax = Maximum int value accepted. This must be > iMin

NOTE: Currently unsigned integers are not explicitly supported, however 16 bit unsigned integers are implicitly supported by the EParamInt type. Note that the constraint above (iMax > iMin) means that the maximum supported value for an unsigned int is 0x7FFFFFFF.

EParamDes8Read: EParamDes16Read: -iMin = Minimum length of descriptor in clients address space. If no minimum restriction exists this should be set to 0 in the schema. This must be >= 0 -iMax = Maximum length of descriptor in clients address space. The descriptor supplied by the client must not have a length that exceeds this value. This must be >= iMin EParamDes8: EParamDes16: -iMin = Minimum MaxLength of descriptor in clients address space. The descriptor supplied by the client must have a MaxLength that is at least as big as this value. This must be >= 0 -iMax = Maximum length of descriptor in clients address space. The descriptor supplied by the client must not have a length that exceeds this value. This must be >= 0.

NOTE: As the EParamDes* types use MaxLength() as a restriction They cannot be used if the client intends to pass a TDesC derived descriptor. If the client intends read only use then the explicit EParamDes*Read types should be used instead.

EParamPckg: -iMin = Minimum length of descriptor in clients address space. If no minimum restriction exists this should be set to 0 in the schema. This must be >= 0 -iMax = Maximum length of descriptor in clients address space. The descriptor supplied by the client must not have a length that exceeds this value. This must be >= iMin

EParamPtr: -iMin = Unused -iMax = Unused