Macro TraceLoggingSocketAddress (traceloggingprovider.h)

Article
03/03/2024

Macro wrapper TraceLogging qui ajoute un champ avec une adresse de socket à l’événement.

Syntaxe

void TraceLoggingSocketAddress(
  [in]            pValue,
  [in]            cbValue,
  [in, optional]  __VA_ARGS__
);

Paramètres

[in] pValue

Pointeur vers une structure de sockaddr.

[in] cbValue

Taille, en octets, de la valeur pointée vers le paramètre pValue .

Notes

La quantité de données nécessaires pour un champ sockaddr varie en fonction du type d’adresse. Si les données sont stockées dans une variable d’union, veillez à définir le paramètre cbValue sur la taille du membre d’union approprié (ou sur la taille de l’union) pour éviter de tronquer les données.

[in, optional] __VA_ARGS__

Paramètres de nom, de description et d’étiquettes facultatifs pour la définition de champ.

TraceLoggingSocketAddress peut être spécifié avec 2, 3, 4 ou 5 paramètres. Si aucun paramètre n’est spécifié, une valeur par défaut est utilisée. Par exemple, TraceLoggingSocketAddress(&x.sockAddr, sizeof(x.sockAddr)) équivaut à TraceLoggingSocketAddress(&x.sockAddr, sizeof(x.sockAddr), "&x.sockAddr", "", 0).

[in, optional] name

Nom à utiliser pour le champ d’événement. S’il est fourni, le paramètre name doit être un littéral de chaîne (et non une variable) et ne doit pas contenir de caractères « \0 ». S’il n’est pas fourni, le nom du champ d’événement sera basé sur pValue.
[in, optional] description

Description de la valeur du champ d’événement. S’il est fourni, le paramètre de description doit être un littéral de chaîne et sera inclus dans le PDB.
[in, optional] tags

Valeur entière constante au moment de la compilation. Les 28 bits faibles de la valeur seront inclus dans les métadonnées du champ. La sémantique de cette valeur est définie par le consommateur d’événements. Pendant le traitement des événements, cette valeur peut être récupérée à partir du champ Balises EVENT_PROPERTY_INFO .

Valeur de retour

None

Remarques

TraceLoggingSocketAddress(pValue, cbValue, ...) peut être utilisé comme paramètre pour l’appel d’une macro TraceLoggingWrite . Chaque paramètre TraceLoggingSocketAddress ajoute un champ à l’événement.

La valeur peut être n’importe quel type de sockaddr Windows, par exemple SOCKADDR, SOCKADDR_IN, SOCKADDR_IN6, SOCKADDR_STORAGE, etc. L’événement enregistre les données binaires brutes et la taille des données. Le décodeur d’événements utilise le sa_family champ pour déterminer le type réel de l’adresse de socket.

Notes

Tous les décodeurs ne prennent pas en charge tous les types de famille sockaddr. Si un sockaddr non pris en charge est rencontré, le décodeur peut décoder le champ en tant que données binaires brutes au lieu de le mettre en forme en tant qu’adresse.

Configuration requise

Condition requise	Valeur
Client minimal pris en charge	Windows Vista [applications de bureau \| applications UWP]
Serveur minimal pris en charge	Windows Server 2008 [applications de bureau \| applications UWP]
Plateforme cible	Windows
En-tête	traceloggingprovider.h

Voir aussi

TraceLoggingWrite

Macros du wrapper TraceLogging

Partager via