GetPrintProcessorCapabilities, fonction (winsplp.h)

Article
02/07/2025

La fonction GetPrintProcessorCapabilities d’un processeur d’impression retourne des fonctionnalités associées à un type de données d’entrée spécifié.

Syntaxe

DWORD GetPrintProcessorCapabilities(
  [in]  LPTSTR  pValueName,
  [in]  DWORD   dwAttributes,
  [out] LPBYTE  pData,
  [in]  DWORD   nSize,
  [out] LPDWORD pcbNeeded
);

Paramètres

[in] pValueName

Pointeur fourni par l’appelant vers une chaîne qui représente un type de données pris en charge par le processeur d’impression. Le pointeur de chaîne doit être de type LPWSTR.

[in] dwAttributes

Indicateurs d’attributs fournis par l’appelant. Reportez-vous aux attributs membre de structures PRINTER_INFO_x.

[out] pData

Pointeur fourni par l’appelant vers une structure PRINTPROCESSOR_CAPS_1 ou PRINTPROCESSOR_CAPS_2.

[in] nSize

Valeur fournie par l’appelant qui représente la taille de la mémoire tampon pointée par pData.

Si la valeur est inférieure à sizeof(PRINTPROCESSOR_CAPS_1), cette fonction doit fournir une valeur égale à sizeof(PRINTPROCESSOR_CAPS_1) ou sizeof(PRINTPROCESSOR_CAPS_2), selon la structure prise en charge par le processeur d’impression.

Si la valeur est inférieure à sizeof(PRINTPROCESSOR_CAPS_1), le processeur d’impression winprint fournit une valeur de sizeof(PRINTPROCESSOR_CAPS_2).

[out] pcbNeeded

Pointeur fourni par l’appelant vers un emplacement pour recevoir la taille minimale requise pour la mémoire tampon pointée par pData.

Valeur de retour

Si l’opération réussit, la fonction doit retourner ERROR_SUCCESS. Sinon, il doit retourner un code d’erreur Win32.

Remarques

Les processeurs d’impression peuvent éventuellement exporter une fonction GetPrintProcessorCapabilities. L’objectif de la fonction est de retourner une structure PRINTPROCESSOR_CAPS_1 ou PRINTPROCESSOR_CAPS_2 remplie pour chaque type de données d’entrée pris en charge par le processeur d’impression.

Le spouleur appelle la fonction GetPrintProcessorCapabilities d’un processeur d’impression lorsqu’une application appelle GetPrinterData, en spécifiant un nom de valeur avec un format de type de données PrintProcCaps_, où type de données est le nom d’un type de données d’entrée. Avant d’appeler GetPrintProcessorCapabilities, le spouleur supprime le préfixe PrintProcCaps_ de la chaîne de nom de valeur.

La fonction doit déterminer si la mémoire tampon reçue est suffisamment grande et, si c’est le cas, doit remplir la structure PRINTPROCESSOR_CAPS_1 ou PRINTPROCESSOR_CAPS_2 et retourner. La valeur de nSize détermine si PRINTPROCESSOR_CAPS_1 ou PRINTPROCESSOR_CAPS_2 seront utilisées.

La fonction doit toujours utiliser l’emplacement vers lequel pointe to retourner la taille de mémoire tampon requise, que la mémoire tampon réelle soit suffisamment grande ou non.

La valeur de retour spécifiée devient la valeur de retour fournie par le spouleur pour GetPrinterData.

Exigences

Exigence	Valeur
plateforme cible	Bureau
d’en-tête	winsplp.h (include Winsplp.h)

Partager via