SHIsFileAvailableOffline-Funktion (shellapi.h)

  • Artikel

Bestimmt, ob eine Datei oder ein Ordner für die Offlineverwendung verfügbar ist. Diese Funktion bestimmt auch, ob die Datei aus dem Netzwerk, aus dem lokalen Offlinedateiencache oder aus beiden Speicherorten geöffnet wird.

Syntax

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

Parameter

[in] pwszPath

Typ: PCWSTR

Ein Zeiger auf einen Zeichenfolgenwert, der den vollständigen Pfad zu einer Netzwerkdatei oder einem Netzwerkverzeichnis angibt. Dieser Pfad muss sich nicht im UNC-Format befinden. Wenn pszPath kein Netzwerkpfad ist, gibt die Funktion E_INVALIDARG zurück.

[out, optional] pdwStatus

Typ: LPDWORD

Ein Zeiger auf eine Variable vom Typ DWORD , die eines oder mehrere der folgenden Flags empfängt, wenn die Funktion erfolgreich ist.

OFFLINE_STATUS_LOCAL (0x01)

Wenn die Datei geöffnet ist, ist sie im Cache geöffnet.

OFFLINE_STATUS_REMOTE (0x02)

Wenn die Datei geöffnet ist, ist sie auf dem Server geöffnet.

OFFLINE_STATUS_INCOMPLETE (0x04)

Die lokale Kopie ist derzeit unvollständig. Die Datei kann erst im Offlinemodus geöffnet werden, wenn sie synchronisiert wurde.

Rückgabewert

Typ: HRESULT

Diese Funktion kann einen dieser Werte zurückgeben.

Rückgabecode BESCHREIBUNG
S_OK
 Die Datei oder das Verzeichnis wird zwischengespeichert. Es ist offline verfügbar, es sei denn , OFFLINE_STATUS_INCOMPLETE festgelegt ist.
E_INVALIDARG
 Der Pfad ist ungültig oder kein Netzwerkpfad. Die Datei oder das Verzeichnis wird nicht zwischengespeichert.
E_FAIL
 Die Datei oder das Verzeichnis wird nicht zwischengespeichert.

Hinweise

Wenn pszPath ein Verzeichnis ist, gibt SHIsFileAvailableOffline das flag OFFLINE_STATUS_INCOMPLETE nicht zurück.

Wenn SHIsFileAvailableOffline sowohl OFFLINE_STATUS_LOCAL als auch OFFLINE_STATUS_REMOTE zurückgibt, ist die Datei oder das Verzeichnis an beiden Orten geöffnet. Dies ist üblich, wenn der Server online ist.

Anforderungen

Anforderung Wert
Unterstützte Mindestversion (Client) Windows 2000 Professional [nur Desktop-Apps]
Unterstützte Mindestversion (Server) Windows 2000 Server [nur Desktop-Apps]
Zielplattform Windows
Kopfzeile shellapi.h
Bibliothek Shell32.lib
DLL Shell32.dll (Version 5.0 oder höher)