ITableEntryHandle.PinSnapshot Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Pin the snapshot for this ITableEntryHandle.
public:
Microsoft::VisualStudio::Shell::TableManager::ITableEntriesSnapshot ^ PinSnapshot();public Microsoft.VisualStudio.Shell.TableManager.ITableEntriesSnapshot PinSnapshot ();abstract member PinSnapshot : unit -> Microsoft.VisualStudio.Shell.TableManager.ITableEntriesSnapshotPublic Function PinSnapshot () As ITableEntriesSnapshotReturns
The ITableEntriesSnapshot used to create this entry or null if it or its equivalent no longer exists.
Remarks
All calls to PinSnapshot() should be matched by calls to UnpinSnapshot().
This will return null (and have no effect) on handles created from ITableEntrys.
If the ITableEntriesSnapshot used to create this handle was directly added to the ITableDataSink, then this method will return that snapshot (but have no effect otherwise).
If the ITableEntriesSnapshot used to create this handle is managed by an ITableEntriesSnapshotFactory, then this method will return its cached snapshot if still exists or it will ask the factory to recreate it if it does not. The factory may not be able to recreate the snapshot and, in that case, this method will return null.