IMAPITable::SetCollapseState
Gilt für: Outlook 2013 | Outlook 2016
Erstellt den aktuellen erweiterten oder reduzierten Zustand einer kategorisierten Tabelle mithilfe von Daten neu, die von einem vorherigen Aufruf der IMAPITable::GetCollapseState-Methode gespeichert wurden.
HRESULT SetCollapseState(
ULONG ulFlags,
ULONG cbCollapseState,
LPBYTE pbCollapseState,
BOOKMARK FAR * lpbkLocation
);
Parameter
ulFlags
Reserviert; muss null sein.
cbCollapseState
[in] Anzahl der Bytes in der Struktur, auf die der pbCollapseState-Parameter verweist.
pbCollapseState
[in] Zeiger auf die Strukturen, die die Daten enthalten, die zum Neuerstellen der Tabellenansicht erforderlich sind.
lpbkLocation
[out] Zeiger auf ein Lesezeichen, das die Zeile in der Tabelle angibt, in der der reduzierte oder erweiterte Zustand neu erstellt werden soll. Dieses Lesezeichen und der instance Schlüssel, der im lpbInstanceKey-Parameter im Aufruf von IMAPITable::GetCollapseState übergeben wird, identifizieren dieselbe Zeile.
Rückgabewert
S_OK
Der Status der kategorisierten Tabelle wurde erfolgreich neu erstellt.
MAPI_E_BUSY
Ein weiterer Vorgang wird ausgeführt, der verhindert, dass der Vorgang gestartet wird. Entweder sollte der laufende Vorgang abgeschlossen oder beendet werden.
MAPI_E_UNABLE_TO_COMPLETE
Die Tabelle konnte die Neuerstellung der reduzierten oder erweiterten Ansicht nicht abschließen.
Hinweise
Die IMAPITable::SetCollapseState-Methode richtet den erweiterten oder reduzierten Zustand der Tabellenansicht wieder ein. SetCollapseState und GetCollapseState arbeiten wie folgt zusammen:
Wenn sich der Status einer kategorisierten Tabelle ändert, wird IMAPITable::GetCollapseState aufgerufen, um alle Daten zu speichern, die sich auf den Zustand vor der Änderung beziehen.
Um die Ansicht der Tabelle in ihren gespeicherten Zustand wiederherzustellen, wird SetCollapseState aufgerufen. Die von GetCollapseState gespeicherten Daten werden an SetCollapseState übergeben. SetCollapseState kann diese Daten verwenden, um den Zustand wiederherzustellen.
SetCollapseState gibt als Ausgabeparameter ein Lesezeichen zurück, das dieselbe Zeile identifiziert wie der instance Schlüssel, der als Eingabe an GetCollapseState übergeben wird.
Weitere Informationen zu kategorisierten Tabellen finden Sie unter Sortieren und Kategorisieren.
Hinweise für Implementierer
Sie sind dafür verantwortlich, zu überprüfen, ob die Sortierreihenfolge und die Einschränkungen genau mit denen zum Zeitpunkt des GetCollapseState-Aufrufs identisch sind. Wenn eine Änderung vorgenommen wurde, sollte SetCollapseState nicht aufgerufen werden, da die Ergebnisse unvorhersehbar sein können. Dies kann beispielsweise der Fall sein, wenn ein Client GetCollapseState und dann SortTable aufruft, um den Sortierschlüssel vor dem Aufruf von SetCollapseState zu ändern. Um sicher zu gehen, überprüfen Sie, ob die gespeicherten Daten noch gültig sind, bevor Sie mit der Wiederherstellung fortfahren.
Hinweise für Aufrufer
Zum Aufrufen von SetCollapseState müssen Sie zuvor GetCollapseState aufgerufen haben. Die Sortierreihenfolge, in der die Kategorien festgelegt werden, sollte für beide Methoden identisch sein. Wenn sich die Sortierreihenfolgen unterscheiden, sind die Ergebnisse des SetCollapseState-Vorgangs unvorhersehbar.