PEParameterFieldInfo

[ROOT] --> C-Client

struct PEParameterFieldInfo

This structure contains information about parameters.

Source:: C:\FlatInclude\Crystal:Structures.h

CurrentValue: [public] Specifies the current value assigned to the parameter field. If CurrentValueSet is False, this value is meaningless. To discard the current value, refresh data.
CurrentValueSet: Indicates whether or not a current value was set for the parameter field. A current value can be set through SetNthParameterField or by a prompting dialog box if the report has saved data.
DefaultValue: Specifies the default value assigned to the parameter field if one was set. If the DefaultValueSet member is false, this value is meaningless.
DefaultValueSet: Indicates whether or not a default value was set for the parameter field. The value can be either TRUE (1) if the field was given a default value or FALSE (0) if it was not.
Name: Specifies the name of the parameter field assigned by the user when the parameter was inserted into the report or the name that was set from code.
needsCurrentValue: TRUE (1) if a current value is required. FALSE (0) if a current value has already been supplied for the parameter field.
Prompt: Specifies the prompting text, if any, that appears in the prompting dialog box. This will be either the prompt assigned by the user when the parameter field was inserted into the report or the prompt that was set from code.
ReportName: The name of the report this parameter field applies to.
StructSize: Specifies the size of the PEParameterFieldInfo structure. You must initialize this member to the size of whatever it is, for example, info.StructSize = PE_SIZEOF_PARAMETER_FIELD_INFO.
ValueType: Specifies the data type of the parameter field. The Crystal Report Engine supports the following data types: number, currency, Boolean, date, and string. Use the appropriate constant from the list below.

StructSize

WORD StructSize

Specifies the size of the PEParameterFieldInfo structure. You must initialize this member to the size of whatever it is, for example, info.StructSize = PE_SIZEOF_PARAMETER_FIELD_INFO.

ValueType

WORD ValueType

Specifies the data type of the parameter field. The Crystal Report Engine supports the following data types: number, currency, Boolean, date, and string. Use the appropriate constant from the list below.

PE_PF_NUMBER Number
PE_PF_CURRENCY Currency
PE_PF_BOOLEAN Boolean
PE_PF_DATE Date
PE_PF_STRING String

DefaultValueSet

WORD DefaultValueSet

Indicates whether or not a default value was set for the parameter field. The value can be either TRUE (1) if the field was given a default value or FALSE (0) if it was not.

CurrentValueSet

WORD CurrentValueSet

Indicates whether or not a current value was set for the parameter field. A current value can be set through SetNthParameterField or by a prompting dialog box if the report has saved data.

Name

char Name [ PE_PF_NAME_LEN ]

Specifies the name of the parameter field assigned by the user when the parameter was inserted into the report or the name that was set from code.

Prompt

char Prompt [ PE_PF_PROMPT_LEN ]

Specifies the prompting text, if any, that appears in the prompting dialog box. This will be either the prompt assigned by the user when the parameter field was inserted into the report or the prompt that was set from code.

DefaultValue

char DefaultValue [ PE_PF_VALUE_LEN ]

Specifies the default value assigned to the parameter field if one was set. If the DefaultValueSet member is false, this value is meaningless.

CurrentValue

char CurrentValue [ PE_PF_VALUE_LEN ]

Specifies the current value assigned to the parameter field. If CurrentValueSet is False, this value is meaningless. To discard the current value, refresh data.

ReportName

char ReportName [ PE_PF_REPORT_NAME_LEN ]

The name of the report this parameter field applies to.

needsCurrentValue

WORD needsCurrentValue

TRUE (1) if a current value is required. FALSE (0) if a current value has already been supplied for the parameter field.