IOfflineFilesSuspendInfo::IsSuspended method (cscobj.h)

Determines whether an item is suspended.

If an item is suspended and is a suspended root, it was suspended by using the IOfflineFilesSuspend::SuspendRoot method. If an item is suspended but is not a suspended root, its suspension was inherited from a suspended root.

Syntax

HRESULT IsSuspended(
  [out] BOOL *pbSuspended,
  [out] BOOL *pbSuspendedRoot
);

Parameters

[out] pbSuspended

Receives TRUE if the item is suspended, or FALSE otherwise.

[out] pbSuspendedRoot

Receives TRUE if the item is a suspended root, or FALSE otherwise. If the item is not suspended, this value is always FALSE.

Return value

Returns S_OK if successful, or an error value otherwise.

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

IOfflineFilesSuspendInfo