IOfflineFilesConnectionInfo::GetConnectState method (cscobj.h)

  • Article

Determines whether an item is online or offline and, if offline, why.

Syntax

HRESULT GetConnectState(
  [out] OFFLINEFILES_CONNECT_STATE  *pConnectState,
  [out] OFFLINEFILES_OFFLINE_REASON *pOfflineReason
);

Parameters

[out] pConnectState

Receives an OFFLINEFILES_CONNECT_STATE enumeration value that indicates whether the item is online or offline.

Note  This value sets the Offline Status property value in Windows Explorer.
 

[out] pOfflineReason

If the item is offline, this parameter receives an OFFLINEFILES_OFFLINE_REASON enumeration value that indicates why the item is offline.

Note  This value generates the parenthesized suffix in the Offline Status property value in Windows Explorer when the status is offline.
 

Return value

Returns S_OK if successful, or an error value otherwise.

Remarks

This method requires that the item have connection state information. If that information is unavailable at the time of this method call, the method call will initiate the extra query of the cache item to obtain the current connection state.

Requirements

Requirement Value
Minimum supported client Windows Vista
Minimum supported server Windows Server 2008
Target Platform Windows
Header cscobj.h
DLL CscSvc.dll; CscObj.dll

See also

IOfflineFilesConnectionInfo