Metodo IStiDevice::Escape (sti.h)

Il metodo IStiDevice::Escape invia una richiesta per un'operazione di I/O specifica del fornitore a un dispositivo ancora immagine.

Sintassi

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

Parametri

[in] EscapeFunction

Chiamante fornito, definito dal fornitore, valore di dimensione DWORD che rappresenta un'operazione di I/O. Il minidriver del dispositivo deve riconoscere questo valore e deve esportare un'interfaccia IStiUSD . I valori definiti dal fornitore devono essere maggiori di STI_RAW_RESERVED, definiti in Sti.h.

[in] lpInData

Puntatore fornito dal chiamante a un buffer contenente dati da inviare al dispositivo.

cbInDataSize

Lunghezza fornita dal chiamante, in byte, dei dati contenuti nel buffer a cui punta lpInData.

[in, out] pOutData

Puntatore fornito dal chiamante a un buffer di memoria per ricevere dati dal dispositivo.

dwOutDataSize

Lunghezza fornita dal chiamante, in byte, del buffer a cui punta lpOutData.

[out] pdwActualData

Riceve il numero di byte effettivamente scritti in pOutData.

Valore restituito

Se l'operazione ha esito positivo, il metodo restituisce S_OK. In caso contrario, restituisce uno dei codici di errore con prefisso STIERR definiti in stierr.h.

Commenti

Il metodo IStiDevice:: Escape chiama IStiUSD::Escape, esportato dai minidriver forniti dal fornitore. Il minidriver del dispositivo definisce l'utilizzo del parametro Metodo.

Prima di chiamare IStiDevice::Escape, i client dell'interfaccia COM IStiDevice devono chiamare IStillImage::CreateDevice per ottenere un puntatore dell'interfaccia IStiDevice , che fornisce l'accesso a un dispositivo specificato.

Una chiamata a IStiDevice::Escape deve essere preceduta da una chiamata a IStiDevice::LockDevice e seguita da una chiamata a IStiDevice::UnLockDevice.

Requisiti