Microsoft Information Protection SDK - C++ 1.17
API Reference Documentation for C++
Loading...
Searching...
No Matches
Public Member Functions | List of all members
StorageDelegate::StorageSettings Class Reference

Settings used by StorageDelegate. More...

#include <storage_delegate.h>

Public Member Functions

 StorageSettings (bool isRemoteStorage, bool isInMemoryStorageSupported, const std::string &onDiskExtension=GetSqliteExtension())
 Interface for configuring the storage settings.
 
bool IsRemoteStorage () const
 Gets whether remote storage is used or not.
 
bool IsInMemoryStorageSupported () const
 Gets whether the delegate supports in-memory storage.
 
std::string OnDiskExtension () const
 Gets the extension that the delegate will use when storing a table on disk.
 

Detailed Description

Settings used by StorageDelegate.

Constructor & Destructor Documentation

◆ StorageSettings()

StorageDelegate::StorageSettings::StorageSettings ( bool isRemoteStorage,
bool isInMemoryStorageSupported,
const std::string & onDiskExtension = GetSqliteExtension() )
inline

Interface for configuring the storage settings.

Parameters
isRemoteStorerepresents if store is remote. This will be taken into account for internal encryption.
isInMemoryStorageSupportedDeclares whether the delegate supports in-memory storage.
onDiskExtensionThe file extension that will be used to store the data if it is needed. Should begin with ".".

Member Function Documentation

◆ IsInMemoryStorageSupported()

bool StorageDelegate::StorageSettings::IsInMemoryStorageSupported ( ) const
inline

Gets whether the delegate supports in-memory storage.

Returns
true if the delegate supports in-memory storage.

◆ IsRemoteStorage()

bool StorageDelegate::StorageSettings::IsRemoteStorage ( ) const
inline

Gets whether remote storage is used or not.

Returns
whether remote storage is used or not.

◆ OnDiskExtension()

std::string StorageDelegate::StorageSettings::OnDiskExtension ( ) const
inline

Gets the extension that the delegate will use when storing a table on disk.

Returns
The extension that will be used. Default to ".sqlite3".
Note
Extension will have "." preceding it
The documentation for this class was generated from the following file: