IOfflineFilesPinInfo::IsPinnedForUser method (cscobj.h)

Determines whether the item was pinned by a user.

Syntax

HRESULT IsPinnedForUser(
  [out] BOOL *pbPinnedForUser,
  [out] BOOL *pbInherit
);

Parameters

[out] pbPinnedForUser

Receives TRUE if the item was pinned by a user, or FALSE otherwise.

[out] pbInherit

Receives TRUE if the pinned state is inherited by new child items, or FALSE otherwise.

Return value

Returns S_OK if successful, or an error value otherwise.

Remarks

When an item is pinned in the Offline Files cache, it is protected from automatic eviction and is guaranteed to be available offline.

This method corresponds to the OFFLINEFILES_PIN_CONTROL_FLAG_FORUSER pin control flag used by the IOfflineFilesCache::Pin method.

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

IOfflineFilesCache::Pin

IOfflineFilesPinInfo