Interface ModelCenter::ICachePin
Last update: 16.07.2025
Definition: ModelCenter/src/ModelCenter.odl (line 6566)
A set of methods for cache pin functions. A cache pin is a "smart" pointer that manages file upload and download of a file to/from a cache.
Members
Properties
Property Url
Definition: ModelCenter/src/ModelCenter.odl (line 1)
BSTR ModelCenter::ICachePin::Url
Get the original URI of the resource; an invalid URI if nothing is pinned.
Returns:
The original URI of the resource, or an invalid URI if nothing pinned.
Return type: BSTR
Property LocalPath
Definition: ModelCenter/src/ModelCenter.odl (line 1)
BSTR ModelCenter::ICachePin::LocalPath
Get the local path of the file in the cache; empty if nothing is pinned.
Returns:
The local path of the file in the cache, or empty if nothing pinned.
Return type: BSTR
Property IsValid
Definition: ModelCenter/src/ModelCenter.odl (line 1)
boolean ModelCenter::ICachePin::IsValid
Is this object pinning a file?
Returns:
true or false
Return type: boolean
Public functions
Function releasePin
boolean ModelCenter::ICachePin::releasePin()
Unpin the current file if a file is pinned. Does not guarantee that the file will be flushed unless this was the last active pin on the file.
Returns:
true if a file was previously pinned or false if not
Return type: boolean
Function checkinOnFlush
void ModelCenter::ICachePin::checkinOnFlush(BSTR message)
Checkin with the specified message when the file is unpinned. It must be open for write, and will be placed under version control if it isn't already. If the medium does not support version control, this is a no-op.
Parameters:
- message: the checkin message; may not be nullptr
Parameters:
- BSTR message
Return type: void
