PEParameterFieldInfo

The PEParameterFieldInfo structure contains information related to parameter fields in a report. This structure is used by PEGetNthParameterField to get information about a specific parameter field and by PESetNthParameterField to change a specific parameter field.

C Syntax
typedef struct PEParameterFieldInfo {
    WORD StructSize;
    WORD ValueType;
    WORD DefaultValueSet;
    WORD CurrentValueSet;
    char Name [PE_PF_NAME_LEN];
    char Prompt [PE_PF_PROMPT_LEN];
    char DefaultValue [PE_PF_VALUE_LEN];
    char CurrentValue [PE_PF_VALUE_LEN];
    char ReportName [PE_PF_REPORT_NAME_LEN];
    WORD needsCurrentValue;
    WORD isLimited;
    double MinSize;
    double MaxSize;
    char EditMask [PE_PF_EDITMASK_LEN];
    WORD isHidden;
} PEParameterFieldInfo;
Members

If you wish to set a parameter to NULL, set the CurrentValue to CRWNULL. CRWULL is of Type String and is independent of the data type of the parameter.

StructSize

Specifies the size of the PEParameterFieldInfo structure. Initialize this member to PE_SIZEOF_PARAMETER_FIELD_INFO.

ValueType

Specifies the data type of the parameter field. The Crystal Report Engine supports the data types and associated PE_PF_XXX Parameter Field Value Type Constants.

DefaultValueSet

For backward compatibility for existing applications only. For all new development set this member to FALSE and use PEAdd/GetNth/SetNthParameterDefaultValue. See Remarks below. This member indicates whether a value is assigned to the DefaultValue parameter field. Use TRUE to indicate that a new value is set or FALSE to indicate no change.

CurrentValueSet

For backward compatibility for existing applications only. For all new development set this member to FALSE and use PEAdd/GetNth/SetNthParameterCurrentValue. See Remarks below. This member indicates whether a value is assigned to the CurrentValue parameter field. Use TRUE to indicate that a new value is set or FALSE to indicate no change.

Name

Specifies the name of the parameter field (of length PE_PF_NAME_LEN = 256, NULL-terminated) to be assigned a new value.

Prompt

Specifies the prompting text (of length PE_PF_PROMPT_LEN = 256, NULL-terminated), if any, that will appear when the user runs the report for the first time or refreshes the data.

DefaultValue

For existing applications only; not for new development. See Remarks below. Specifies the default value assigned to the parameter field. If the DefaultValueSet member is FALSE, this value is meaningless. DefaultValue can be a Number, Currency, Date, DateTime, Time, Boolean, or String (of length PE_PF_VALUE_LEN = 256).

CurrentValue

For existing applications only; not for new development. See Remarks below. Specifies the current value assigned to the parameter field. If CurrentValueSet is FALSE, this value is meaningless. CurrentValue can be a Number, Currency, Date, DateTime, Time, Boolean, or String (of length PE_PF_VALUE_LEN = 256).

ReportName

The name of the report (of length PE_PF_REPORT_NAME_LEN = 128) where the field belongs (used only with PEGetNthParameterField).

needsCurrentValue

Returns FALSE if the parameter is linked, not in use, or has current value set.

isLimited

For string values, this will be TRUE if the string is limited on length. For other types, it will be TRUE if the parameter is limited by a range. This capability is not supported currently in Web Viewers.

MinSize

Use for numeric and string fields. Depending on the value type, contains the minimum length of the string or minimum numeric value. For non-numeric and non-string fields (for example, Date/Time), use PEGetParameterMinMaxValue, and PESetParameterMinMaxValue. This capability is not supported currently in Web Viewers.

MaxSize

Use for numeric and string fields. Depending on the value type, contains the maximum length of the string or maximum numeric value. For non-numeric and non-string fields (for example, Date/Time), use PEGetParameterMinMaxValue, and PESetParameterMinMaxValue. This capability is not supported currently in Web Viewers.

EditMask

An edit mask (of length PEP_PF_EDITMASK_LEN = 256) that restricts what may be entered for string parameters. This capability is not supported currently in Web Viewers.

isHidden

TRUE if an essbase sub var. This capability is not supported currently in Web Viewers.

Remarks
VB type listing
Type PEParameterFieldInfo
    StructSize As Integer
    ValueType As Integer
    DefaultValueSet As Integer
    CurrentValueSet As Integer
    Name As String * PE_PF_NAME_LEN
    Prompt As String * PE_PF_PROMPT_LEN
    DefaultValue As String * PE_PF_VALUE_LEN
    CurrentValue As String * PE_PF_VALUE_LEN
    ReportName As String * PE_PF_REPORT_NAME_LEN
    needsCurrentValue As Integer
    isLimited As Integer
    MinSize As Double
    MaxSize As Double
    EditMask As String * PE_PF_EDITMASK_LEN
    isHidden As Integer
End Type
Delphi listing
type
    PEParameterFieldValueType = array[0..PE_PF_NAME_LEN-1] of char;
    PE_PF_ReportNameType = array[0..PE_PF_REPORT_NAME_LEN-1] of char;
PEParameterFieldNameType = array [0..PE_PF_NAME_LEN-1] of Char;
PEParameterFieldEditMaskType = array [0..PE_PF_EDITMASK_LEN-1] of
Char;

    PEParameterFieldInfo = record
        structSize: Word;
        ValueType: Word;
        DefaultValueSet: Word;
        CurrentValueSet: Word;
        Name: PEParameterFieldNameType;
        Prompt: PEParameterFieldTextType;
        DefaultValue: PEParameterFieldValueType;
        CurrentValue: PEParameterFieldValueType;
        ReportName: PE_PF_ReportNameType;
        needsCurrentvalue: Word;
        isLimited: Word;
        MinSize: double;
        MaxSize: double;
        EditMask: PEParameterFieldEditMaskType;
        isHidden: Word;
    end;


Seagate Software IMG Holdings, Inc.
http://www.seagatesoftware.com
Support services:
http://support.seagatesoftware.com