Método IStiDevice::Escape (sti.h)

O método IStiDevice::Escape envia uma solicitação para uma operação de E/S específica do fornecedor para um dispositivo de imagem parada.

Sintaxe

HRESULT Escape(
  [in]      STI_RAW_CONTROL_CODE EscapeFunction,
  [in]      LPVOID               lpInData,
            DWORD                cbInDataSize,
  [in, out] LPVOID               pOutData,
            DWORD                dwOutDataSize,
  [out]     LPDWORD              pdwActualData
);

Parâmetros

[in] EscapeFunction

Valor de tamanho DWORD fornecido pelo chamador, definido pelo fornecedor, que representa uma operação de E/S. O minidriver do dispositivo deve reconhecer esse valor e exportar uma interface IStiUSD . Os valores definidos pelo fornecedor devem ser maiores que STI_RAW_RESERVED, que é definido em Sti.h.

[in] lpInData

Ponteiro fornecido pelo chamador para um buffer que contém dados a serem enviados para o dispositivo.

cbInDataSize

Comprimento fornecido pelo chamador, em bytes, dos dados contidos no buffer apontado por lpInData.

[in, out] pOutData

Ponteiro fornecido pelo chamador para um buffer de memória para receber dados do dispositivo.

dwOutDataSize

Comprimento fornecido pelo chamador, em bytes, do buffer apontado por lpOutData.

[out] pdwActualData

Recebe o número de bytes realmente gravados em pOutData.

Retornar valor

Se a operação for bem-sucedida, o método retornará S_OK. Caso contrário, ele retornará um dos códigos de erro prefixados por STIERR definidos em stierr.h.

Comentários

O método IStiDevice::Escape chama IStiUSD::Escape, que é exportado por minidrivers fornecidos pelo fornecedor. O minidriver do dispositivo define o uso do parâmetro Method.

Antes de chamar IStiDevice::Escape, os clientes da interface COM IStiDevice devem chamar IStillImage::CreateDevice para obter um ponteiro de interface IStiDevice , que fornece acesso a um dispositivo especificado.

Uma chamada para IStiDevice::Escape deve ser precedida por uma chamada para IStiDevice::LockDevice e seguida por uma chamada para IStiDevice::UnLockDevice.

Requisitos

Requisito	Valor
Plataforma de Destino	Área de Trabalho
Cabeçalho	sti.h (inclua Sti.h)