Funzione NtDeviceIoControlFile (ntifs.h)

Articolo
02/29/2024

La routine ZwDeviceIoControlFile invia un codice di controllo direttamente a un driver di dispositivo specificato, causando l'esecuzione dell'operazione specificata dal driver corrispondente.

Sintassi

__kernel_entry NTSYSCALLAPI NTSTATUS NtDeviceIoControlFile(
  [in]            HANDLE           FileHandle,
  [in, optional]  HANDLE           Event,
  [in, optional]  PIO_APC_ROUTINE  ApcRoutine,
  [in, optional]  PVOID            ApcContext,
  [out]           PIO_STATUS_BLOCK IoStatusBlock,
  [in]            ULONG            IoControlCode,
  [in, optional]  PVOID            InputBuffer,
  [in]            ULONG            InputBufferLength,
  [out, optional] PVOID            OutputBuffer,
  [in]            ULONG            OutputBufferLength
);

Parametri

[in] FileHandle

Handle restituito da ZwCreateFile o ZwOpenFile per l'oggetto file che rappresenta il dispositivo a cui devono essere fornite o da quali informazioni devono essere restituite. L'oggetto file deve essere stato aperto per I/O asincrono se il chiamante specifica un oggetto Event, ApcRoutine e un contesto APC (in ApcContext) o un contesto di completamento (in ApcContext). Per I/O a un dispositivo di archiviazione di massa sottostante, l'oggetto file deve essere stato aperto per l'accesso diretto al dispositivo di archiviazione (DASD).

[in, optional] Event

Handle per un evento creato dal chiamante. Se questo parametro viene fornito, il chiamante verrà inserito in uno stato di attesa fino al completamento dell'operazione richiesta e l'evento specificato viene impostato sullo stato Signaled. Questo parametro è facoltativo e può essere NULL. Deve essere NULL se il chiamante attenderà che il fileHandle sia impostato sullo stato segnalato.

[in, optional] ApcRoutine

Indirizzo di una routine APC facoltativa fornita dal chiamante da chiamare al termine dell'operazione richiesta. Questo parametro può essere NULL. Deve essere NULL se è presente un oggetto di completamento di I/O associato all'oggetto file.

[in, optional] ApcContext

Puntatore a un'area di contesto determinata dal chiamante. Questo valore di parametro viene usato come contesto APC se il chiamante fornisce un APC o viene usato come contesto di completamento se un oggetto di completamento di I/O è stato associato all'oggetto file. Al termine dell'operazione, il contesto APC viene passato all'APC, se è stato specificato o il contesto di completamento viene incluso come parte del messaggio di completamento che l'oggetto di completamento di I/O Manager esegue il post dell'oggetto di completamento I/O associato.

Questo parametro è facoltativo e può essere NULL. Deve essere NULL se ApcRoutine è NULL e non esiste alcun oggetto di completamento I/O associato all'oggetto file.

[out] IoStatusBlock

Puntatore a una variabile che riceve lo stato di completamento finale e informazioni sull'operazione. Per le chiamate riuscite che restituiscono dati, il numero di byte scritti in OutputBuffer viene restituito nel membro Information .

[in] IoControlCode

IOCTL_ CodiceXxx che indica l'operazione di controllo I/O del dispositivo da eseguire, in genere dal driver del dispositivo sottostante. Il valore di questo parametro determina il formato e la lunghezza necessaria dell'oggetto InputBuffer e OutputBuffer, oltre alla quale sono necessarie le coppie di parametri seguenti. Per informazioni dettagliate sui codici di IOCTL_Xxx definiti dal sistema definiti dal sistema, vedere la sezione specifica della tecnologia del dispositivo della documentazione di Microsoft Windows Driver Kit (WDK) e Dei codici di controllo di input del dispositivo e di output.

[in, optional] InputBuffer

Puntatore a un buffer di input allocato dal chiamante che contiene informazioni specifiche del dispositivo da fornire al dispositivo di destinazione. Se IoControlCode specifica un'operazione che non richiede dati di input, questo puntatore può essere NULL.

[in] InputBufferLength

Dimensioni, in byte, del buffer in InputBuffer. Se InputBuffer è NULL, impostare InputBufferLength su zero.

[out, optional] OutputBuffer

Puntatore a un buffer di output allocato dal chiamante in cui le informazioni vengono restituite dal dispositivo di destinazione. Se IoControlCode specifica un'operazione che non produce dati di output, questo puntatore può essere NULL.

[in] OutputBufferLength

Dimensioni, in byte, del buffer in OutputBuffer. Se OutputBuffer è NULL, impostare OutputBufferLength su zero.

Valore restituito

ZwDeviceIoControlFile restituisce STATUS_SUCCESS se i driver sottostanti hanno eseguito correttamente l'operazione richiesta. In caso contrario, il valore restituito può essere un codice di stato di errore propagato da un driver sottostante. I codici di stato degli errori possibili includono quanto segue:

Commenti

ZwDeviceIoControlFile offre una visualizzazione coerente dei dati di input e output al sistema e ai driver in modalità kernel, fornendo applicazioni e driver sottostanti con un metodo dipendente dal dispositivo per specificare un'interfaccia di comunicazione.

Per altre informazioni sui codici di IOCTL_Xxx definiti dal sistema e sulla definizione di valori di IOCTL_ IOCTL_Xxx specifici del driver o di FSCTL_Xxx, vedere Uso di codici di controllo I/O e Codici di controllo di input del dispositivo e di output.

Se il chiamante ha aperto il file per I/O asincrono (senza FILE_SYNCHRONOUS_Xxx create/open option set), l'evento specificato, se presente, verrà impostato sullo stato segnalato al termine dell'operazione di controllo del dispositivo. In caso contrario, l'oggetto file specificato da FileHandle verrà impostato sullo stato segnalato. Se è stato specificato un oggetto ApcRoutine , viene chiamato con i puntatori ApcContext e IoStatusBlock .

I minifilter devono usare FltDeviceIoControlFile anziché ZwDeviceIoControlFile.

I chiamanti di ZwDeviceIoControlFile devono essere in esecuzione in IRQL = PASSIVE_LEVEL e con API kernel speciali abilitate.

Se la chiamata alla funzione ZwDeviceIoControlFile si verifica in modalità utente, è necessario usare il nome "NtDeviceIoControlFile" anziché "ZwDeviceIoControlFile".

Per le chiamate dai driver in modalità kernel, le versioni NtXxx e ZwXxx di una routine di Windows Native System Services possono comportarsi in modo diverso nel modo in cui gestiscono e interpretano i parametri di input. Per altre informazioni sulla relazione tra le versioni NtXxx e ZwXxx di una routine, vedere Uso di nt e zw versioni delle routine di Servizi di sistema nativo.

Requisiti

Requisito	Valore
Client minimo supportato	Windows 2000
Piattaforma di destinazione	Universale
Intestazione	ntifs.h (include Ntifs.h, Ntddk.h)
Libreria	NtosKrnl.lib
DLL	NtosKrnl.exe
IRQL	PASSIVE_LEVEL (vedere la sezione Osservazioni)
Regole di conformità DDI	HwStorPortProhibitedDDIs, PowerIrpDDis