Retrieves information about an effect.
- macOS 10.2+
An opaque reference handle to an effect object. This is obtained from a previous call to FFDeviceCreateEffect.
Address of a FFEFFECT structure that receives effect information. The dwSize member must be filled in by the application before calling this method.
Flags that specify which parts of the effect information are to be retrieved. The value can be 0 or one or more of the following constants:
The union of all other FFEP_* flags, indicating that all members of the FFEFFECT structure are being requested.
The cAxes and rgdwAxes members should receive data. The cAxes member on entry contains the size (in DWORDs) of the buffer pointed to by the rgdwAxes member. If the buffer is too small, the method returns FFERR_MOREDATA and sets cAxes to the necessary size of the buffer.
The cAxes and rglDirection members should receive data. The cAxes member on entry contains the size (in DWORDs) of the buffer pointed to by the rglDirection member. If the buffer is too small, the GetParameters method returns FFERR_MOREDATA and sets cAxes to the necessary size of the buffer.
The dwFlags member must include at least one of the coordinate system flags (FFEFF_CARTESIAN, FFEFF_POLAR, or FFEFF_SPHERICAL). The API returns the direction of the effect in one of the coordinate systems you specified, converting between coordinate systems as necessary. On exit, exactly one of the coordinate system flags is set in the dwFlags member, indicating which coordinate system the FF API used. In particular, passing all three coordinate system flags retrieves the coordinates in exactly the same format in which they were set.
The dwDuration member should receive data.
The lpEnvelope member points to a FFENVELOPE structure that should receive data. If the effect does not have an envelope associated with it, the lpEnvelope member is set to NULL.
The dwGain member should receive data.
The dwSamplePeriod member should receive data.
The dwStartDelay member should receive data.
The dwTriggerButton member should receive data.
The dwTriggerRepeatInterval member should receive data.
The lpvTypeSpecificParams member points to a buffer whose size is specified by the cbTypeSpecificParams member. On return, the buffer is filled in with the type-specific data associated with the effect, and the cbTypeSpecificParams member contains the number of bytes copied. If the buffer supplied by the application is too small to contain all the type-specific data, the method returns FFERR_MOREDATA, and the cbTypeSpecificParams member contains the required size of the buffer in bytes.
If the method succeeds, the return value is FF_OK. If the method fails, the return value can be one of the following error values:
Common errors resulting in a FFERR_INVALIDPARAM error include not setting the dwSize member of the FFEFFECT structure, passing invalid flags, or not setting up the members in the FFEFFECT structure properly in preparation for receiving the effect information.