Edit

Share via

IWiaItemExtras::Escape method (wia_xp.h)

  • Article

The IWiaItemExtras::Escape method sends a request for a vendor-specific I/O operation to a still image device.

Syntax

HRESULT Escape(
  [in]  DWORD dwEscapeCode,
  [in]  BYTE  *lpInData,
  [in]  DWORD cbInDataSize,
  [out] BYTE  *pOutData,
  [in]  DWORD dwOutDataSize,
  [out] DWORD *pdwActualDataSize
);

Parameters

[in] dwEscapeCode

Type: DWORD

Calling application-supplied, vendor-defined, DWORD-sized value that represents an I/O operation.

[in] lpInData

Type: BYTE*

Pointer to a calling application-supplied buffer that contains data to be sent to the device.

[in] cbInDataSize

Type: DWORD

Calling application-supplied length, in bytes, of the data contained in the buffer pointed to by lpInData.

[out] pOutData

Type: BYTE*

Pointer to a calling application-supplied memory buffer to receive data from the device.

[in] dwOutDataSize

Type: DWORD

Calling application-supplied length, in bytes, of the buffer pointed to by pOutData.

[out] pdwActualDataSize

Type: DWORD*

Receives the number of bytes actually written to pOutData.

Return value

Type: HRESULT

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Requirements

Requirement Value
Minimum supported client Windows 2000 Professional, Windows XP [desktop apps only]
Minimum supported server Windows Server 2003 [desktop apps only]
Target Platform Windows
Header wia_xp.h (include Wia.h)
Library Wiaguid.lib
DLL Wiaservc.dll

See also

IWiaItemExtras