This reference page is linked to from the following overview topics: Parameter Validation.

Detailed Description

See also:: List of ParamType2 Choices, Class FPParamOptions, Template Class Tab.

Description:: This class is available in release 4.0 and later only.

This class contains a descriptor for each published function, found in Tab<> in FPInterface.

Data Members:: MSTR internal_name;

The internal name.

StringResID description;

The string resource ID of the description.

ParamType2 type;

The parameter type. See the List of ParamType2 Choices for details.

EnumID enumID;

ID of symbolic enumeration in owning interface if any.

USHORT flags;

The parameter definition flags;

FPP_HAS_RANGE

Indicates that the parameter definition contains a range.

FPP_HAS_VALIDATOR

Indicates that the parameter has a validator.

FPP_IN_PARAM

In flag used by _BR ref types to decide when to pass in source values or hand back returns.

FPP_OUT_PARAM

Out flag used by _BR ref types to decide when to pass in source values or hand back returns.

FPP_IN_OUT_PARAM

In-Out flag used by _BR ref types to decide when to pass in source values or hand back returns.

FPP_KEYARG

If p_keyArgDefault supplied, the client can use keyword args if supported for this param.

FPP_INDEX

Parameter values used as indexes, always 0-origin internally, allows client to map to other origins.

FPParamOptions* options;

Present if non-NULL, a pointer to the parameter options object.

#include <ifnpub.h>

Inheritance diagram for FPParamDef:

Constructor & Destructor Documentation

FPParamDef ( ) [inline]

Default Implementation:: { description = 0; options = NULL; flags = FPP_IN_OUT_PARAM; enumID = FP_NO_ENUM; }

: cbStruct(sizeof(FPParamDef)), description(0), options(NULL), enumID(FP_NO_ENUM), flags(FPP_IN_OUT_PARAM) { }

CoreExport ~FPParamDef ( )

StringResID description

ParamType2 type

EnumID enumID

USHORT flags