Méthode IXpsOMGradientStop ::SetColor (xpsobjectmodel.h)

Article
03/05/2024

Définit la valeur de couleur et le profil de couleur du taquet de dégradé.

Syntaxe

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

Paramètres

[in] color

Valeur de couleur à définir au niveau du dégradé.

Si la valeur du champ colorType dans la structure XPS_COLOR passée dans ce paramètre est XPS_COLOR_TYPE_CONTEXT, un profil de couleur valide doit être fourni dans le paramètre colorProfile .

[in] colorProfile

Profil de couleur à utiliser avec la couleur.

Un profil de couleur est requis lorsque la valeur du champ colorType dans la structure XPS_COLOR passée dans le paramètre de couleur est XPS_COLOR_TYPE_CONTEXT. Si la valeur du champ colorType n’est pas XPS_COLOR_TYPE_CONTEXT, ce paramètre doit avoir la valeur NULL.

Valeur retournée

Cette méthode retourne un code HRESULT. Les valeurs possibles incluent, sans s’y limiter, celles du tableau qui suit. Pour plus d’informations sur les valeurs de retour de l’API de document XPS qui ne sont pas répertoriées dans ce tableau, consultez Erreurs de document XPS.

Code de retour	Description
S_OK	S_OK
E_POINTER	la couleur est NULL.
XPS_E_MISSING_COLORPROFILE	colorProfile a la valeur NULL lorsqu’un profil de couleur était attendu. Un profil de couleur est requis lorsque le type de couleur est XPS_COLOR_TYPE_CONTEXT.
XPS_E_NO_CUSTOM_OBJECTS	colorProfile ne pointe pas vers une implémentation d’interface reconnue. L’implémentation personnalisée des interfaces d’API document XPS n’est pas prise en charge.
XPS_E_UNEXPECTED_COLORPROFILE	colorProfile contenait un profil de couleur alors qu’il n’était pas attendu. Un profil de couleur n’est autorisé que lorsque le type de couleur est XPS_COLOR_TYPE_CONTEXT.

Remarques

Un profil de couleur n’est requis que lorsque le type de couleur est XPS_COLOR_TYPE_CONTEXT.

Configuration requise

Condition requise	Valeur
Client minimal pris en charge	Windows 7, Windows Vista avec SP2 et Mise à jour de plateforme pour Windows Vista [applications de bureau \| Applications UWP]
Serveur minimal pris en charge	Windows Server 2008 R2, Windows Server 2008 avec SP2 et Platform Update pour Windows Server 2008 [applications de bureau \| Applications UWP]
Plateforme cible	Windows
En-tête	xpsobjectmodel.h