[ROOT] --> C-Client

struct PCREParameterField

A structure used for storing information about parameter fields.

Source:
Include\pcreapi.h

Variables Index

CurrentValue
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.
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
The size of this structure
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 Crystal Developers Help


Variables

structSize

WORD structSize

The size of this structure.

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 Crystal Developers Help.

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.

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

PEValueInfo DefaultValue

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

CurrentValue

PEValueInfo CurrentValue

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.


Copyright (c) 2000 Dynalivery Corp.