IStiUSD ::Escape, méthode (stiusd.h)

La méthode IStiUSD ::Escape d’un minidriver d’image fixe effectue une opération d’E/S spécifique au fournisseur sur un appareil d’image fixe.

Syntaxe

HRESULT Escape(
  STI_RAW_CONTROL_CODE EscapeFunction,
  LPVOID               lpInData,
  DWORD                cbInDataSize,
  LPVOID               pOutData,
  DWORD                cbOutDataSize,
  LPDWORD              pdwActualData
);

Paramètres

EscapeFunction

Valeur DWORD fournie par l’appelant, définie par le fournisseur, représentant une opération d’E/S. Les valeurs définies par le fournisseur doivent être supérieures à STI_RAW_RESERVED, qui est définie dans Sti.h.

lpInData

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

cbInDataSize

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

pOutData

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

cbOutDataSize

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

pdwActualData

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

Valeur retournée

Si l’opération réussit, la méthode doit retourner S_OK. Sinon, il doit retourner l’un des codes d’erreur préfixés STIERR définis dans stierr.h. Si la méthode n’est pas implémentée, elle doit retourner STIERR_UNSUPPORTED.

Remarques

Un minidriver d’image fixe doit uniquement implémenter IStiUSD ::Escape si des opérations d’E/S ne peuvent pas être implémentées dans les méthodes IStiUSD ::RawReadData, IStiUSD ::RawWriteData, IStiUSD ::RawReadCommand ou IStiUSD ::RawWriteCommand . Le minidriver définit l’utilisation des paramètres pour IStiUSD ::Escape.

Configuration requise

Voir aussi

IStiDevice ::Escape

IStiUSD