Microsoft DirectX 8.1 (Visual Basic)

DirectInputDevice8.WriteEffectToFile

Writes a force-feedback effect to a file.

object.WriteEffectToFile( _
  filename As String, _
  flags As Long, _
  guid As String, _
  name As String, _
  CoverEffect As DIEFFECT)

Parts

object
Resolves to a DirectInputDevice8 object.
filename
Name of the RIFF file. If the file exists, it is overwritten.
flags
Flags which control how the effect should be written. Can be one of the following values from the CONST_DIFEFFLAGS enumeration.

DIFEF_DEFAULT

Do not write the effect if it is not a standard type.

DIFEF_INCLUDENONSTANDARD

Write the effect even if it is not a standard type.

guid
Identifier of the effect type, such as "GUID_RampForce". For a list of standard effects, see DirectInputDevice8.CreateEffect. For nonstandard effects, this parameter must be a string representation of the numerical GUID.
name
Friendly name of the effect.
CoverEffect
DIEFFECT type that specifies parameters of the effect.

Error Codes

If the method fails, an error is raised and Err.Number may be one of the following error codes.

DIERR_INVALIDPARAM

Remarks

This method is chiefly of interest for force-authoring applications.

See Also

DirectInputDevice8.CreateEffectFromFile