OfflineFilesQueryStatusEx function (cscapi.h)

Determines whether the Offline Files feature is enabled and, if so, whether it is active and available. This function is identical to the OfflineFilesQueryStatus function, except that it has an additional output parameter.

Syntax

DWORD OfflineFilesQueryStatusEx(
  [out] BOOL *pbActive,
  [out] BOOL *pbEnabled,
  [out] BOOL *pbAvailable
);

Parameters

[out] pbActive

Receives TRUE if both the CSC driver and Offline Files Service are in the running state, or FALSE otherwise. This parameter is optional and can be NULL.

[out] pbEnabled

Receives TRUE if the CSC driver's start type is set to SERVICE_SYSTEM_START and the Offline Files service's start type is set to SERVICE_AUTO_START, or FALSE otherwise. This parameter is optional and can be NULL.

[out] pbAvailable

Receives TRUE if the Offline Files Service is ready to be started without requiring the computer to be restarted, or FALSE otherwise. This parameter is optional and can be NULL.

Return value

Returns ERROR_SUCCESS if successful or a Win32 error value otherwise.

Remarks

If the pbAvailable parameter is TRUE on return, the caller can use the OfflineFilesStart function to start the Offline Files feature.

Requirements

Requirement Value
Minimum supported client Windows 8
Minimum supported server Windows Server 2012
Target Platform Windows
Header cscapi.h
Library CscApi.lib
DLL CscApi.dll

See also

OfflineFilesQueryStatus