Funzione WofIsExternalFile (wofapi.h)

Articolo
03/08/2023

Usato per determinare se un file è supportato da un file fisico o supportato da un provider di dati di sistema e, facoltativamente, indica quale provider o dati aggiuntivi sul file.

Sintassi

HRESULT WofIsExternalFile(
  [in]                LPCWSTR FilePath,
  [out, optional]     PBOOL   IsExternalFile,
  [out, optional]     PULONG  Provider,
  [out, optional]     PVOID   ExternalFileInfo,
  [in, out, optional] PULONG  BufferLength
);

Parametri

[in] FilePath

Specifica il percorso del file per il quale lo stato di backup è desiderato.

[out, optional] IsExternalFile

Facoltativamente punta a un valore BOOL. In caso di esito positivo, questo valore sarà TRUE se l'oggetto è supportato esternamente, FALSE se si tratta di un file fisico.

[out, optional] Provider

Facoltativamente punta a un valore ULONG. In caso di esito positivo, questo valore verrà impostato sul provider che esegue esternamente il backup dell'oggetto. I provider attualmente definiti sono:

WOF_PROVIDER_WIM	Indica che i dati per il file si trovano in un file WIM separato. All'accesso, i dati vengono estratti in modo trasparente, decompresso e fornito alle applicazioni. Se il contenuto del file viene modificato, i dati vengono decompressi in modo trasparente e il file viene ripristinato in un file normale.
WOF_PROVIDER_FILE	Indica che i dati per il file devono essere compressi e archiviati con il file stesso. In caso di accesso, i dati vengono decompressi in modo trasparente e forniti alle applicazioni. Se il contenuto del file viene modificato, i dati vengono decompressi in modo trasparente e il file viene ripristinato in un file normale. Questo provider richiede Windows 10.

[out, optional] ExternalFileInfo

Facoltativamente punta a un buffer allocato dal chiamante. In caso di esito positivo, questo buffer conterrà informazioni aggiuntive sullo stato del file. Se viene specificato questo valore, è necessario specificare anche BufferLength . Le strutture di dati per ogni provider definito sono:

WOF_PROVIDER_WIM	WIM_EXTERNAL_FILE_INFO
WOF_PROVIDER_FILE	WOF_FILE_COMPRESSION_INFO

[in, out, optional] BufferLength

Facoltativamente punta a un valore che contiene la lunghezza del buffer specificato in ExternalFileInfo. In caso di restituzione, questo valore verrà impostato sulle dimensioni del buffer utilizzato o sulle dimensioni del buffer necessarie. Se la lunghezza del buffer è insufficiente, questa funzione avrà esito positivo indicando le dimensioni necessarie e non popolerà il buffer in ExternalFileInfo. Questa lunghezza deve corrispondere a una delle strutture definite in precedenza:

WOF_PROVIDER_WIM	sizeof(WIM_EXTERNAL_FILE_INFO)
WOF_PROVIDER_FILE	sizeof(WOF_FILE_COMPRESSION_INFO)

Valore restituito

Questa funzione restituisce un valore HRESULT che indica l'esito positivo o il motivo dell'errore. Se il buffer specificato in ExternalFileInfo non è di dimensioni corrette, la funzione restituirà S_OK e indicherà le dimensioni del buffer necessarie in BufferLength.

Requisiti

Requisito	Valore
Piattaforma di destinazione	Windows
Intestazione	wofapi.h
Libreria	Wofutil.lib
DLL	Wofutil.dll

Vedi anche

FSCTL_GET_EXTERNAL_BACKING

Condividi tramite