Type et description du paramètre

char cShortSessionID
ID de session court de l’espace de présentation.
PRINTINFO * const pPrintInfo
Pointeur vers la structure PRINTINFO, où les paramètres de l’imprimante sont spécifiés.
nFlags
Doit être défini sur 0. Ceci est ignoré.
nBufSize
Taille du buffer alloué pour les champs suivants :
  • lpPDTFile
  • lpPrtToDskAppFile
  • lpPrtToDskSepFile
  • lpPrinterName
Si plusieurs de ces membres sont récupérés dans un seul appel d'API, l'appelant doit alors allouer la même taille à tous les tampons et transmettre cette taille dans ce membre.

Si ce membre est défini sur 0, les champs sont ignorés. La taille maximale requise pour les buffers des champs est renvoyée dans nSizeNeeded.

nSizeNeeded
La valeur de ce membre est déterminée par des conditions liées aux champs suivants :
  • lpPDTFile
  • lpPrtToDskAppFile
  • lpPrtToDskSepFile
  • lpPrinterName
Les conditions sont les suivantes :
  • La valeur est le nombre d'octets nécessaires, si la taille du tampon alloué par l'appelant n'est pas suffisamment grande pour renvoyer les champs répertoriés ci-dessus.
  • La valeur correspond à la taille maximale du tampon requis, si plusieurs des champs répertoriés ci-dessus sont obtenus par l'appelant.
  • Si nBufSize est défini sur 0 par l'appelant, ce membre contient la taille maximale requise pour les tampons des champs répertoriés ci-dessus.
bPromptDialog
Les valeurs possibles sont les suivantes :
  • Si TRUE, la boîte de dialogue Printer Setup s'affiche avant l'impression.
  • Si FALSE, la boîte de dialogue Printer Setup ne s'affiche pas avant l'impression.
bPDTMode
Les valeurs possibles sont les suivantes :
  • Si TRUE, la session hôte est en mode PDT.
  • Si FALSE, la session hôte est en mode non-PDT (mode GDI).
lpPDTFile
Doit être défini sur NULL si l’appelant n’est pas intéressé à obtenir ce membre. Le fichier PDT est renvoyé s'il ne s'agit pas d'un pointeur nul. Celui-ci doit pointer vers le tampon de taille nBufSize alloué par l'appelant.
Lorsque l'API est renvoyée, ce membre contient l'un des éléments suivants :
  • Nom de chemin complet du fichier PDT de session.
  • Une chaîne vide («  ») si aucun fichier PDT n'est configuré dans la session.
  • Un nom de fichier tronqué si la taille du tampon n'est pas suffisante. Le membre nSizeNeeded contient la taille du tampon nécessaire.
nPrtMode
Il s'agit d'une valeur énumérée qui indique le PrintMode de la connexion. Le type de données enum PRINTMODE est défini dans PCSAPI32.H. Le paramètre nPrtMode doit être l’un des suivants :
  • PrtToDskAppend (mode Print to Disk-Append)

    Cela équivaut à sélectionner l'option Append dans la boîte de dialogue Printer Setup → Printer → Print to Diskde la session hôte.

  • PrtToDskSeparate (mode Print to Disk-Separate)

    Cela équivaut à sélectionner l'option Separate dans la boîte de dialogue Printer Setup → Printer → Print to Disk de la session hôte.

  • WinDefaultPrinter (mode Windows Default Printer)

    Cela équivaut à sélectionner l'option Use Windows Default Printer dans la boîte de dialogue Printer Setup de la session hôte.

  • SpecificPrinter (mode Specific Printer)

    Cela équivaut à sélectionner une imprimante dans la boîte de dialogue Printer Setup de la session hôte, tout en laissant la case Use Windows Default Printer décochée.

lpPrtToDskAppFile
Doit être défini sur NULL si l’appelant n’est pas intéressé à obtenir ce membre. Le fichier Print to Disk-Append est renvoyé s’il ne s’agit pas d’un pointeur Null. Celui-ci doit pointer vers le tampon de taille nBufSize alloué par l'appelant.
Lorsque l'API est renvoyée, ce membre contient l'un des éléments suivants :
  • Le nom de chemin complet du fichier Print to Disk-Append de la session.
  • Une chaîne vide («  ») si aucun fichier Print to Disk-Append n'est configuré pour la session.
  • Un nom de fichier tronqué si la taille du tampon n'est pas suffisante. Le membre nSizeNeeded contient la taille du tampon nécessaire.
lpPrtToDskSepFile
Doit être défini sur NULL si l’appelant n’est pas intéressé à obtenir ce membre. Le fichier Print to Disk-Separate est renvoyé s’il ne s’agit pas d’un pointeur nul. Celui-ci doit pointer vers le tampon de taille nBufSize alloué par l'appelant.
Lorsque l'API est renvoyée, ce membre contient l'un des éléments suivants :
  • Nom de chemin complet du fichier Print to Disk-Separate de la session.
  • Une chaîne vide («  ») si aucun fichier Print to Disk-Separate n'est configuré pour la session.
  • Un nom de fichier tronqué si la taille du tampon n'est pas suffisante. Le membre nSizeNeeded contient la taille du tampon nécessaire.
lpPrinterName
Doit être défini sur NULL si l’appelant n’est pas intéressé à obtenir ce membre. Le nom de l'imprimante est renvoyé s'il ne s'agit pas d'un pointeur Null. Celui-ci doit pointer vers le tampon de taille nBufSize alloué par l'appelant.
Lorsque l'API est renvoyée, ce membre possède l'un des éléments suivants :
  • Le nom de l'imprimante spécifique configurée dans la session, si la session hôte nPrtMode est SpecificPrinter.
  • Le nom de l'imprimante par défaut Windows configurée dans la session, si la session hôte nPrtMode est WinDefaultPrinter.
  • Une chaîne vide («  »), si la session hôte nPrtMode est PrtToDskAppend ou PrtToDskSeparate.
  • Un nom d'imprimante tronqué, si la taille du tampon n'est pas suffisante. nSizeNeeded a la taille du tampon nécessaire.
PrinterName doit avoir le format suivant : 
<Nom de l'imprimante> sur <Nom du port>
Par exemple :
  • IBM InfoPrint 40 PS sur port réseau
  • HP LaserJet série 4050 PCL 6 sur LPT1
ULONG * const pErrorInfo
Ceci est rempli avec les informations d'erreur étendues lorsque l'API échoue avec le code retour PCS_FAILURE. pErrorInfo doit être défini sur NULL par l'appelant, si les détails des erreurs ne sont pas nécessaires.

La section suivante décrit les indicateurs définis dans PCSAPI32.H.