IOfflineFilesCache::GetSettingObject method

Creates an object that represents a particular Offline Files setting.

Syntax


HRESULT GetSettingObject(
  [in]  LPCWSTR              pszSettingName,
  [out] IOfflineFilesSetting **ppSetting
);

Parameters

pszSettingName [in]

Case-insensitive name of the setting. One of the following values:

L"AdminPinMinFreeSpace"
L"AlwaysPinSubfolders"
L"AutoCacheMaxUsedSpace"
L"ClientSideShareSetting"
L"Enabled"
L"EncryptCache"
L"NoCacheViewer"
L"NoConfigCache"
L"NoMakeAvailableOffline"
L"NoMakeAvailableOfflineList"
ppSetting [out]

If the setting exists, a pointer to the object's IOfflineFilesSetting interface is returned.

Return value

Returns S_OK if successful, or an error value otherwise.

Returns HRESULT_FROM_WIN32(ERROR_INVALID_NAME) if the setting name is invalid.

Remarks

This method is available to both administrators and non-administrators. Security restrictions are enforced on a setting-by-setting basis. For example, only administrators can alter a setting that applies to all users on the computer.

Requirements

Minimum supported client

Windows Vista

Minimum supported server

Windows Server 2008

Header

CscObj.h

DLL

CscSvc.dll;
CscObj.dll

See also

IOfflineFilesCache

 

 

Show: