IXpsOMGradientStop::SetColor-Methode (xpsobjectmodel.h)

Artikel
03/05/2024

Legt den Farbwert und das Farbprofil des Farbverlaufsstopps fest.

Syntax

HRESULT SetColor(
  [in] const XPS_COLOR            *color,
  [in] IXpsOMColorProfileResource *colorProfile
);

Parameter

[in] color

Der Farbwert, der am Farbverlaufsstopp festgelegt werden soll.

Wenn der Wert des Felds colorType in der XPS_COLOR-Struktur , die in diesem Parameter übergeben wird, XPS_COLOR_TYPE_CONTEXT ist, muss im colorProfile-Parameter ein gültiges Farbprofil angegeben werden.

[in] colorProfile

Das Farbprofil, das mit Farbe verwendet werden soll.

Ein Farbprofil ist erforderlich, wenn der Wert des ColorType-Felds in der XPS_COLOR-Struktur , die im farbparameter übergeben wird , XPS_COLOR_TYPE_CONTEXT ist. Wenn der Wert des ColorType-Felds nicht XPS_COLOR_TYPE_CONTEXT ist, muss dieser Parameter auf NULL festgelegt werden.

Rückgabewert

Die Methode gibt ein HRESULT zurück. Mögliche Werte sind unter anderem diejenigen in der folgenden Tabelle. Informationen zu Rückgabewerten der XPS-Dokument-API, die in dieser Tabelle nicht aufgeführt sind, finden Sie unter XPS-Dokumentfehler.

Rückgabecode	BESCHREIBUNG
S_OK	Die Methode wurde erfolgreich ausgeführt.
E_POINTER	Farbe ist NULL.
XPS_E_MISSING_COLORPROFILE	colorProfile ist NULL , wenn ein Farbprofil erwartet wurde. Ein Farbprofil ist erforderlich, wenn der Farbtyp XPS_COLOR_TYPE_CONTEXT ist.
XPS_E_NO_CUSTOM_OBJECTS	colorProfile verweist nicht auf eine erkannte Schnittstellenimplementierung. Die benutzerdefinierte Implementierung von XPS-Dokument-API-Schnittstellen wird nicht unterstützt.
XPS_E_UNEXPECTED_COLORPROFILE	colorProfile enthielt ein Farbprofil, wenn eines nicht erwartet wurde. Ein Farbprofil ist nur zulässig, wenn der Farbtyp XPS_COLOR_TYPE_CONTEXT ist.

Hinweise

Ein Farbprofil ist nur erforderlich, wenn der Farbtyp der FarbeXPS_COLOR_TYPE_CONTEXT ist.

Anforderungen

Anforderung	Wert
Unterstützte Mindestversion (Client)	Windows 7, Windows Vista mit SP2 und Plattformupdate für Windows Vista [Desktop-Apps \| UWP-Apps]
Unterstützte Mindestversion (Server)	Windows Server 2008 R2, Windows Server 2008 mit SP2 und Plattformupdate für Windows Server 2008 [Desktop-Apps \| UWP-Apps]
Zielplattform	Windows
Kopfzeile	xpsobjectmodel.h