Méthode IDebugClient5 ::GetRunningProcessDescription (dbgeng.h)

Article
02/23/2024

La méthode GetRunningProcessDescription retourne une description du processus qui inclut le nom de l’image exécutable, les noms de service, les noms du package MTS et la ligne de commande.

Syntaxe

HRESULT GetRunningProcessDescription(
  [in]            ULONG64 Server,
  [in]            ULONG   SystemId,
  [in]            ULONG   Flags,
  [out, optional] PSTR    ExeName,
  [in]            ULONG   ExeNameSize,
  [out, optional] PULONG  ActualExeNameSize,
  [out, optional] PSTR    Description,
  [in]            ULONG   DescriptionSize,
  [out, optional] PULONG  ActualDescriptionSize
);

Paramètres

[in] Server

Spécifie le serveur de processus à interroger pour la description du processus. Si Server est égal à zéro, le moteur interroge directement les informations sur le processus local.

[in] SystemId

Spécifie l’ID de processus du processus dont la description est souhaitée.

[in] Flags

Spécifie un jeu de bits contenant des options qui affectent le comportement de cette méthode. Les indicateurs peuvent contenir les indicateurs de bits suivants :

Indicateur	Description
DEBUG_PROC_DESC_NO_PATHS	Retourne uniquement les noms de fichiers sans noms de chemin d’accès.
DEBUG_PROC_DESC_NO_SERVICES	Ne recherchez pas de noms de service.
DEBUG_PROC_DESC_NO_MTS_PACKAGES	Ne recherchez pas de noms de package MTS.
DEBUG_PROC_DESC_NO_COMMAND_LINE	Ne récupérez pas la ligne de commande.

[out, optional] ExeName

Reçoit le nom du fichier exécutable utilisé pour démarrer le processus. Si ExeName a la valeur NULL, ces informations ne sont pas retournées.

[in] ExeNameSize

Spécifie la taille en caractères de la mémoire tampon ExeNameSize. Cette taille inclut l’espace pour le caractère de fin « \0 ».

[out, optional] ActualExeNameSize

Reçoit la taille en caractères du nom de fichier exécutable. Cette taille inclut l’espace pour le caractère de fin « \0 ». Si ExeNameSize a la valeur NULL, ces informations ne sont pas retournées.

[out, optional] Description

Reçoit des informations supplémentaires sur le processus, notamment les noms de service, les noms de package MTS et la ligne de commande. Si Description a la valeur NULL, ces informations ne sont pas retournées.

[in] DescriptionSize

Spécifie la taille en caractères de la description de la mémoire tampon. Cette taille inclut l’espace pour le caractère de fin « \0 ».

[out, optional] ActualDescriptionSize

Reçoit la taille en caractères des informations supplémentaires. Cette taille inclut l’espace pour le caractère de fin « \0 ». Si ActualDescriptionSize a la valeur NULL, ces informations ne sont pas retournées.

Valeur retournée

Cette méthode peut également retourner des valeurs d’erreur. Pour plus d’informations, consultez Valeurs de retour.

Code de retour	Description
S_OK	La méthode a réussi.
S_FALSE	La méthode a réussi. Toutefois, ExeNameSize ou DescriptionSize étaient plus petits que la taille de la chaîne respective et la chaîne a été tronquée pour tenir dans la mémoire tampon.