public:
     virtual bool __fastcall GetParameters( TDIEffect* pEffect, dword pFlags );

• Description
• Parameters
• See Also

If you would like to submit additions or improvements to this page, click: admin@bcb-tools.com.

The GetParameters() method retrieves the current settings of the effect.

Error values that can be generated are:

DIERR_INVALIDPARAM
DIERR_MOREDATA
DIERR_NOTINITIALIZED

Effect
The Effect parameter references a TDIEffect component for holding the effect information if this method returns successfully.

Flags
The Flags parameter defines flags indicating which properties of the TDIEffect component referenced by the Effect parameter are to be retrieved.
The described effect applies when the flag is set.

DIEP_ALLPARAMS
All the TDIEffect properties are to be retrieved.

This is equivilent to setting all the other flags of this parameter.

DIEP_ALLPARAMS_DX5
All the TDIEffect properties except TDIEffect::StartDelay are to be retrieved.

This is equivilent to setting all the other flags of this parameter except DIEP_STARTDELAY.

DIEP_AXES
TDIEffect::NumAxes and TDIEffect::Axes are to be retrieved.

TDIEffect::NumAxes holds the size of the buffer referenced by TDIEffect::Axes.
When the TDIEffect::Axes buffer is too small, a DIERR_MOREDATA error is generated and TDIEffect::NumAxes will indicate the required buffer size.

DIEP_DIRECTION
TDIEffect::NumAxes and TDIEffect::Direction are to be retrieved.

TDIEffect::NumAxes holds the size of the buffer referenced by TDIEffect::Direction.
When the TDIEffect::Direction buffer is too small, a DIERR_MOREDATA error is generated and TDIEffect::NumAxes will indicate the required buffer size.

One or more of the DIEFF_CARTESIAN, DIEFF_POLAR or DIEFF_SPHERICAL flags must be set in TDIEffect::Flags to indicate in which coordinate system the directions should be reported.
Setting all three will result in the coordinates being retrieved using the same system as when they were set.
On returning, only one of the coordinate system flags will be set, indicating how the TDIEffect::Direction coordinates should be interpreted.

DIEP_DURATION
TDIEffect::Duration is to be retrieved.

DIEP_ENVELOPE
The TDIEnvelope component referenced by TDIEffect::Envelope is to be filled and retrieved.

When there is no envelope TDIEffect::Envelope will be NULL when the method returns.

DIEP_GAIN
TDIEffect::GAIN is to be retrieved.

DIEP_SAMPLEPERIOD
TDIEffect::SamplePeriod is to be retrieved.

DIEP_STARTDELAY
TDIEffect::StartDelay is to be retrieved.

DIEP_TRIGGERBUTTON
TDIEffect::TriggerButton is to be retrieved.

DIEP_TRIGGERREPEATINTERVAL
TDIEffect::TriggerRepeatInterval is to be retrieved.

DIEP_TYPESPECIFICPARAMS
Any type specific parameters referenced by TDIEffect::TypeSpecificParams are retrieved.

TDIEffect::TypeSpecificParamsSize initially holds the size the TDIEffect::TypeSpecificParams buffer and the actual amount of data written to the buffer on return.
When the TDIEffect::TypeSpecificParams buffer is too small, a DIERR_MOREDATA error is generated and TDIEffect::TypeSpecificParamsSize will indicate the required buffer size.

TDx_InputEffect
TDIEffect