Fungsi SHIsFileAvailableOffline (shellapi.h)

Artikel
03/02/2024

Menentukan apakah file atau folder tersedia untuk digunakan secara offline. Fungsi ini juga menentukan apakah file akan dibuka dari jaringan, dari cache File Offline lokal, atau dari kedua lokasi.

Sintaks

SHSTDAPI SHIsFileAvailableOffline(
  [in]            PCWSTR pwszPath,
  [out, optional] DWORD  *pdwStatus
);

Parameter

[in] pwszPath

Jenis: PCWSTR

Penunjuk ke nilai string yang menentukan jalur lengkap ke file atau direktori jaringan. Jalur ini tidak perlu dalam bentuk UNC. Jika pszPath bukan jalur jaringan, fungsi mengembalikan E_INVALIDARG.

[out, optional] pdwStatus

Jenis: LPDWORD

Penunjuk ke variabel jenis DWORD yang menerima satu atau beberapa bendera berikut jika fungsi berhasil.

OFFLINE_STATUS_LOCAL (0x01)

Jika file terbuka, file terbuka di cache.

OFFLINE_STATUS_REMOTE (0x02)

Jika file terbuka, file terbuka di server.

OFFLINE_STATUS_INCOMPLETE (0x04)

Salinan lokal saat ini tidak lengkap. File tidak dapat dibuka dalam mode luring hingga file disinkronkan.

Mengembalikan nilai

Jenis: HRESULT

Fungsi ini dapat mengembalikan salah satu nilai ini.

Menampilkan kode	Deskripsi
S_OK	File atau direktori di-cache. Ini tersedia secara offline kecuali OFFLINE_STATUS_INCOMPLETE diatur.
E_INVALIDARG	Jalur tidak valid atau bukan jalur jaringan. File atau direktori tidak di-cache.
E_FAIL	File atau direktori tidak di-cache.

Keterangan

Jika pszPath adalah direktori, SHIsFileAvailableOffline tidak akan mengembalikan bendera OFFLINE_STATUS_INCOMPLETE .

Jika SHIsFileAvailableOffline mengembalikan OFFLINE_STATUS_LOCAL dan OFFLINE_STATUS_REMOTE, file atau direktori terbuka di kedua tempat. Ini umum terjadi ketika server online.

Persyaratan

Persyaratan	Nilai
Klien minimum yang didukung	Windows 2000 Professional [hanya aplikasi desktop]
Server minimum yang didukung	Windows 2000 Server [hanya aplikasi desktop]
Target Platform	Windows
Header	shellapi.h
Pustaka	Shell32.lib
DLL	Shell32.dll (versi 5.0 atau yang lebih baru)

Bagikan melalui