IStiDevice ::Escape, méthode (sti.h)

Article
02/07/2025

La méthode IStiDevice ::Escape envoie une demande d’opération d’E/S spécifique au fournisseur à un appareil toujours image.

Syntaxe

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

Paramètres

[in] EscapeFunction

Valeur de taille DWORD fournie par l’appelant, définie par le fournisseur et représentant une opération d’E/S. Le minidriver de l’appareil doit reconnaître cette valeur et exporter une interface IStiUSD. Les valeurs définies par le fournisseur doivent être supérieures à STI_RAW_RESERVED, qui est définie dans Sti.h.

[in] lpInData

Pointeur fourni par l’appelant vers une mémoire tampon contenant les données à envoyer à l’appareil.

cbInDataSize

Longueur fournie par l’appelant, en octets, des données contenues dans la mémoire tampon pointées par lpInData.

[in, out] pOutData

Pointeur fourni par l’appelant vers une mémoire tampon pour recevoir des données de l’appareil.

dwOutDataSize

Longueur fournie par l’appelant, en octets, de la mémoire tampon pointée par lpOutData.

[out] pdwActualData

Reçoit le nombre d’octets réellement écrits dans pOutData .

Valeur de retour

Si l’opération réussit, la méthode retourne S_OK. Sinon, elle retourne l’un des codes d’erreur préfixés STIERR définis dans stierr.h.

Remarques

La méthode IStiDevice ::Escape appelle IStiUSD ::Escape, qui est exportée par des minidrivers fournis par le fournisseur. Le minidriver de l’appareil définit l’utilisation des paramètres de méthode.

Avant d’appeler IStiDevice ::Escape, les clients de l’interface COM IStiDevice doivent appeler IStillImage ::CreateDevice pour obtenir un pointeur d’interface IStiDevice, qui fournit l’accès à un appareil spécifié.

Un appel à IStiDevice ::Escape doit être précédé d’un appel à IStiDevice ::LockDevice et suivi d’un appel à IStiDevice ::UnLockDevice.

Exigences

Exigence	Valeur
plateforme cible	Bureau
d’en-tête	sti.h (include Sti.h)

Partager via