IOfflineFilesConnectionInfo::SetConnectState method (cscobj.h)

Article
02/22/2024

Sets the connection state for an item.

Note that the entire scope of the item is transitioned, not just the item. An item's scope is defined as the closest ancestor shared folder of the item.

Syntax

HRESULT SetConnectState(
  [in] HWND                       hwndParent,
  [in] DWORD                      dwFlags,
  [in] OFFLINEFILES_CONNECT_STATE ConnectState
);

Parameters

[in] hwndParent

Provides a parent window handle used for any interactive user interface elements such as credential request dialogs. This parameter may be NULL. This parameter is ignored if the OFFLINEFILES_TRANSITION_FLAG_INTERACTIVE flag is not specified in the dwFlags parameter.

[in] dwFlags

One or more of the following flag values:

OFFLINEFILES_TRANSITION_FLAG_INTERACTIVE (0x00000001)

Set this flag if the operation is allowed to display user interface elements as necessary. An example is the system's credential-request dialog. If this flag is set, the value in the hwndParent parameter is used as the parent window for any user interface elements displayed.

OFFLINEFILES_TRANSITION_FLAG_CONSOLE (0x00000002)

This flag is ignored if the OFFLINEFILES_TRANSITION_FLAG_INTERACTIVE flag is not set. If the OFFLINEFILES_TRANSITION_FLAG_INTERACTIVE flag is set, this flag indicates that any UI produced should be directed to the console window associated with the process invoking the operation.

[in] ConnectState

Specify one of the following OFFLINEFILES_CONNECT_STATE enumeration values.

OFFLINEFILES_CONNECT_STATE_OFFLINE

Transition the item to offline. Note that this operation will fail if there are currently open handles to affected files that are not cached by Offline Files. The IOfflineFilesConnectionInfo::TransitionOffline method allows you to control the closing of such handles.

OFFLINEFILES_CONNECT_STATE_ONLINE

Transitions the item online if possible. This is equivalent to the IOfflineFilesConnectionInfo::TransitionOnline method.

Return value

Returns S_OK if successful, or an error value otherwise.

Remarks

The IOfflineFilesConnectionInfo::TransitionOnline and IOfflineFilesConnectionInfo::TransitionOffline methods are preferred over this method as they provide greater control over the handling and detecting of open handles in the online-to-offline transition.

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