ITnef::FinishComponent

Gilt für: Outlook 2013 | Outlook 2016

Verarbeitet einzelne Komponenten einzeln aus einer Nachricht in einen TNEF-Stream (Transport-Neutral Encapsulation Format).

HRESULT FinishComponent(
  ULONG ulFlags,
  ULONG ulComponentID,
  LPSPropTagArray lpCustomPropList,
  LPSPropValue lpCustomProps,
  LPSPropTagArray lpPropList,
  LPSTnefProblemArray FAR * lppProblems
);

Parameter

ulFlags

[in] Eine Bitmaske mit Kennzeichnungen, die steuert, welche Komponente beendet wird. Mindestens eines der folgenden Kennzeichnungen muss festgelegt werden:

TNEF_COMPONENT_ATTACHMENT

Die Verarbeitung für ein Anlagenobjekt wird abgeschlossen. Der ulComponentID-Parameter enthält die PR_ATTACH_NUM (PidTagAttachNumber)-Eigenschaft der Anlage.

TNEF_COMPONENT_MESSAGE

Die Verarbeitung für ein Nachrichtenobjekt wird abgeschlossen.

ulComponentID

[in] 0, um die Verarbeitung für eine Nachricht oder die PR_ATTACH_NUM-Eigenschaft einer Anlage anzugeben, die verarbeitet werden soll. Wenn die TNEF_COMPONENT_MESSAGE-Kennzeichnung im ulFlags-Parameter festgelegt ist, muss ulComponentID 0 sein.

lpCustomPropList

[in] Ein Zeiger auf eine SPropTagArray-Struktur, die Eigenschaftenkennzeichnungen enthält, die die im lpCustomProps-Parameter übergebenen Eigenschaften identifizieren. Zwischen jedem Eigenschaftswert in lpCustomProps und einer Eigenschaftenkennzeichnung im lpCustomPropList-Parameter muss eine 1:1-Entsprechung bestehen.

lpCustomProps

[in] Ein Zeiger auf eine SPropValue-Struktur, die Eigenschaftswerte für die zu codenden Eigenschaften enthält.

lpPropList

[in] Ein Zeiger auf eine SPropTagArray-Struktur, die Eigenschaftstags für die zu codenden Eigenschaften enthält.

lppProblems

[out] Ein Zeiger auf einen Zeiger auf eine zurückgegebene STnefProblemArray-Struktur. Die STnefProblemArray-Struktur gibt an, welche Eigenschaften ggf. nicht ordnungsgemäß codiert wurden. Wenn NULL im lppProblems-Parameter übergeben wird, wird kein Eigenschaftenproblemarray zurückgegeben.

Rückgabewert

S_OK

Der Aufruf erfolgreich ausgeführt und der erwartete Wert oder Werte zurückgegeben hat.

Hinweise

Transportanbieter, Nachrichtenspeicheranbieter und Gateways rufen die ITnef::FinishComponent-Methode auf, um die TNEF-Verarbeitung für eine Komponente auszuführen, entweder eine Nachricht oder eine Anlage, wie durch die im ulFlags-Parameter festgelegte Kennzeichnung angegeben.

Damit die Komponentenverarbeitung aktiviert wird, übergibt der aufrufende Anbieter oder das Gateway das flag TNEF_COMPONENT_ENCODING in ulFlags für die OpenTnefStream- oder OpenTnefStreamEx-Funktion, die das Objekt zum Empfangen der Codierung geöffnet hat.

Die Übergabe von Werten in den Parametern lpCustomPropList und lpCustomProps führt eine Komponentencodierung durch, die der von der ITnef::SetProps-Methode durchgeführten entspricht. Die Übergabe eines Werts im lpPropList-Parameter führt eine Komponentencodierung durch, die der von der ITnef::AddProps-Methode mit der in ulFlags festgelegten TNEF_PROP_INCLUDE-Kennzeichnung entspricht. Wenn Sie diese Werte übergeben, können Sie Codierungen mit einem einzigen Aufruf anstelle mehrerer Aufrufe ausführen.

Die TNEF-Implementierung meldet TNEF-Datenstromcodierungsprobleme, ohne den FinishComponent-Prozess zu beenden. Die inlppProblems zurückgegebene STnefProblemArray-Struktur gibt an, welche TNEF-Attribute oder MAPI-Eigenschaften ggf. nicht verarbeitet werden konnten. Der Wert, der im Scode-member einer der in STnefProblemArray enthaltenen STnefProblem-Strukturen zurückgegeben wird, gibt das spezifische Problem an. Der Anbieter oder das Gateway kann davon ausgehen, dass alle Eigenschaften oder Attribute, für die FinishComponent keinen Problembericht zurückgibt, erfolgreich verarbeitet wurden.

Wenn ein Anbieter oder Gateway nicht mit Problemarrays funktioniert, kann er NULL in lppProblems übergeben. In diesem Fall wird kein Problemarray zurückgegeben.

Der in lppProblems zurückgegebene Wert ist nur gültig, wenn der Aufruf S_OK zurückgibt. Wenn S_OK zurückgegeben wird, sollte der Anbieter oder das Gateway die in der STnefProblemArray-Struktur zurückgegebenen Werte überprüfen. Wenn beim Aufruf ein Fehler auftritt, wird die STnefProblemArray-Struktur nicht ausgefüllt, und der aufrufende Anbieter oder das Gateway sollte die Struktur weder verwenden noch freigeben. Wenn beim Aufruf kein Fehler auftritt, muss der aufrufende Anbieter oder das Gateway den Arbeitsspeicher für das STnefProblemArray freigeben, indem er die MAPIFreeBuffer-Funktion aufruft.

Siehe auch

ITnef::AddProps
ITnef::SetProps
MAPIFreeBuffer
OpenTnefStream
OpenTnefStreamEx
SPropTagArray
STnefProblemArray
ITnef : IUnknown