Fungsi FindFirstStreamW (fileapi.h)

Artikel
08/23/2023

Menghitung aliran pertama dengan jenis aliran ::$DATA dalam file atau direktori yang ditentukan.

Untuk melakukan operasi ini sebagai operasi yang ditransaksikan, gunakan fungsi FindFirstStreamTransactedW .

Sintaks

HANDLE FindFirstStreamW(
  [in]  LPCWSTR            lpFileName,
  [in]  STREAM_INFO_LEVELS InfoLevel,
  [out] LPVOID             lpFindStreamData,
        DWORD              dwFlags
);

Parameter

[in] lpFileName

Nama file yang sepenuhnya memenuhi syarat.

[in] InfoLevel

Tingkat informasi data yang dikembalikan. Parameter ini adalah salah satu nilai dalam jenis enumerasi STREAM_INFO_LEVELS .

Nilai	Makna
FindStreamInfoStandard 0	Data dikembalikan dalam struktur WIN32_FIND_STREAM_DATA .

[out] lpFindStreamData

Penunjuk ke buffer yang menerima data aliran file. Format data ini tergantung pada nilai parameter InfoLevel .

dwFlags

Disiapkan untuk penggunaan masa mendatang. Parameter ini harus nol.

Nilai kembali

Jika fungsi berhasil, nilai yang dikembalikan adalah handel pencarian yang dapat digunakan dalam panggilan berikutnya ke fungsi FindNextStreamW .

Jika fungsi gagal, nilai yang dikembalikan INVALID_HANDLE_VALUE. Untuk mendapatkan informasi kesalahan yang diperluas, hubungi GetLastError.

Jika tidak ada aliran yang dapat ditemukan, fungsi gagal dan GetLastError mengembalikan ERROR_HANDLE_EOF (38).

Jika sistem file tidak mendukung aliran, fungsi gagal dan GetLastError mengembalikan ERROR_INVALID_PARAMETER (87).

Keterangan

Fungsi FindFirstStreamW membuka handel pencarian dan mengembalikan informasi tentang aliran $DATA pertama dalam file atau direktori yang ditentukan. Untuk file, ini selalu merupakan aliran data default yang tidak disebutkan namanya, "::$DATA". Direktori tidak memiliki aliran $DATA secara default dan tidak dapat memiliki aliran data yang tidak disebutkan namanya, tetapi mungkin telah menamai aliran data yang ditetapkan setelah dibuat. Setelah handel pencarian dibuat, gunakan dalam panggilan ke fungsi FindNextStreamW untuk mencari aliran lain dalam file atau direktori yang ditentukan. Ketika handel pencarian tidak lagi diperlukan, handel harus ditutup menggunakan fungsi FindClose .

Di Windows 8 dan Windows Server 2012, fungsi ini didukung oleh teknologi berikut.

Teknologi	Didukung
Protokol Server Message Block (SMB) 3.0	Ya
SMB 3.0 Transparent Failover (TFO)	Ya
SMB 3.0 dengan Berbagi File Peluasan Skala (SO)	Ya
Sistem File Volume Bersama Kluster (CsvFS)	Ya
Sistem File Tangguh (ReFS)	Ya

SMB 3.0 mendukung daftar aliran kurang dari atau sama dengan 64K.

Persyaratan


Klien minimum yang didukung	Windows Vista [hanya aplikasi desktop]
Server minimum yang didukung	Windows Server 2003 [hanya aplikasi desktop]
Target Platform	Windows
Header	fileapi.h (termasuk Windows.h, WinBase.h)
Pustaka	Kernel32.lib
DLL	Kernel32.dll