IDirectInputEffect::Escape Method

Sends a hardware-specific command to the driver.

Syntax

HRESULT Escape(      

    LPDIEFFESCAPE pesc
);

Parameters

pesc

DIEFFESCAPE structure that describes the command to be sent. On success, the cbOutBuffer member contains the number of bytes of the output buffer used.

Return Value

If the method succeeds, the return value is DI_OK.

If the method fails, the return value can be one of the following error values:

DIERR_NOTINITIALIZED	The object has not been initialized.
DIERR_DEVICEFULL	The device is full.

Remarks

Other device-specific error codes are also possible. Ask the hardware manufacturer for details.

Because each driver implements different escapes, it is the application's responsibility to ensure that it is sending the escape to the correct driver by comparing the value of the guidFFDriver member of the DIDEVICEINSTANCE structure against the value the application is expecting.