SHIsFileAvailableOffline 関数 (shellapi.h)

ファイルまたはフォルダーをオフラインで使用できるかどうかを決定します。 この関数は、ファイルをネットワークから開くか、ローカルのオフライン ファイル キャッシュから開くか、両方の場所から開くかも決定します。

構文

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

パラメーター

[in] pwszPath

種類: PCWSTR

ネットワーク ファイルまたはディレクトリへの完全パスを指定する文字列値へのポインター。 このパスは UNC 形式である必要はありません。 pszPath がネットワーク パスでない場合、関数は E_INVALIDARGを返します。

[out, optional] pdwStatus

型: LPDWORD

関数が成功した場合に次のフラグの 1 つ以上を受け取る DWORD 型の変数へのポインター。

OFFLINE_STATUS_LOCAL (0x01)

ファイルが開いている場合は、キャッシュで開きます。

OFFLINE_STATUS_REMOTE (0x02)

ファイルが開いている場合は、サーバー上で開きます。

OFFLINE_STATUS_INCOMPLETE (0x04)

現在、ローカル コピーは不完全です。 ファイルは、同期されるまでオフライン モードで開くことができません。

戻り値

型: HRESULT

この関数は、これらの値のいずれかを返すことができます。

注釈

pszPath がディレクトリの場合、SHIsFileAvailableOffline はOFFLINE_STATUS_INCOMPLETE フラグを返しません。

SHIsFileAvailableOffline がOFFLINE_STATUS_LOCALとOFFLINE_STATUS_REMOTEの両方を返す場合、ファイルまたはディレクトリは両方の場所で開かれます。 これは、サーバーがオンラインの場合に一般的です。

要件