Méthode ListSpooledFiles()
Description
La méthode ListSpooledFiles permet de récupérer une liste de fichiers spool disponibles sur le système, en fonction des filtres fournis.
Elle renvoie une liste d’objets de type SpooledFile contenant des informations telles que le nom du fichier spool, le nom du job, et d'autres détails.
Syntaxe
ListSpooledFiles(string filterOutqueue = "*ALL", string filterUser = "*ALL", string filterFormType = "*ALL", string filterUserData = "*ALL")Paramètres
| Nom | Type | Description |
|---|---|---|
filterOutqueue |
string |
Filtre sur la file de sortie à interroger (par défaut *ALL). |
filterUser |
string |
Filtre sur l’utilisateur (par défaut *ALL). |
filterFormType |
string |
Filtre sur le type de formulaire (par défaut *ALL). |
filterUserData |
string |
Filtre sur les données utilisateurs (par défaut *ALL). |
Retour
Retourne une liste d’objets de type SpooledFile qui contient des informations sur chaque fichier spool récupéré.
Classe SpooledFile
| Propriété | Type | Description |
|---|---|---|
| FileName | string |
Nom du fichier spool. |
| JobName | string |
Nom du travail ayant généré le fichier spool. |
| UserName | string |
Nom de l’utilisateur ayant exécuté le travail. |
| JobNumber | string |
Numéro du travail ayant généré le fichier spool. |
| SpooledFileNumber | int |
Numéro unique du fichier spool. |
| OutQueueName | string |
Nom de la file de sortie où se trouve le fichier spool. |
| OutQueueLibraryName | string |
Nom de la bibliothèque contenant la file de sortie. |
| Device | string |
Nom du périphérique de sortie. |
| UserSpecifiedData | string |
Données spécifiées par l'utilisateur pour ce fichier spool. |
| Status | string |
État actuel du fichier spool (ex. : *PRINT, *HOLD, etc.). |
| TotalPages | int |
Nombre total de pages du fichier spool. |
| CurrentPage | int |
Page actuelle en cours d'impression ou de traitement. |
| CopiesLeft | int |
Nombre de copies restantes à produire. |
| FormType | string |
Type de formulaire requis pour l'impression. |
| Priority | string |
Priorité du fichier spoulé dans la file de sortie. |
| DateOpened | string |
Date d'ouverture (création) du fichier. |
| TimeOpened | string |
Heure d'ouverture (création) du fichier . |
| DateTimeOpened | DateTime |
Date et heure combinées de la création du fichier. |
| InternalJobID | byte[] |
Identifiant interne du travail. |
| InternalSpooledFileID | byte[] |
Identifiant interne du fichier spool. |
| DeviceTupe | string |
Type de périphérique utilisé pour la sortie. |
| DateLastUsed | string |
Date de dernière utilisation du fichier. |
| DateTimeLastUsed | DateTime |
Date de dernière utilisation. |
| FileSizeMultiplier | int |
Multiplicateur de taille du fichier spool. |
| FileSize | int |
Taille actuelle du fichier spool. |
| Asp | int |
Pool de stockage auxiliaire associé au fichier spool. |
| JobSystemName | string |
Nom du système pour le travail. |
| AspDeviceName | string |
Nom du périphérique de stockage auxiliaire. |
| DateCreatedUTC | string |
Date de création en UTC. |
| TimeCreatedUTC | string |
Heure de création en UTC. |
| DateTimeCreatedUTC | DateTime |
Date et heure combinées de la création en UTC. |
Exceptions
Aucune exception spécifique pour cette méthode.
Exemples d’utilisation
var spooledFiles = conn.ListSpooledFiles("*ALL", "USER");
foreach (var spooledFile in spooledFiles)
{
Console.WriteLine($"Fichier spool : {spooledFile.FileName}, Job : {spooledFile.JobName}, Pages : {spooledFile.TotalPages}");
}Références
Pour plus d’informations sur l’API QUSLSPL, consultez la documentation officielle IBM.
