StorPortNvmeMiniportEvent, fonction (storport.h)
Un pilote miniport NVMe appelle la fonction StorPortNvmeMiniportEvent pour consigner un événement ETW sur un canal spécifique avec jusqu’à huit paramètres à usage général supplémentaires.
Syntaxe
ULONG StorPortNvmeMiniportEvent(
PVOID HwDeviceExtension,
PVOID ControllerHandle,
ULONG NamespaceId,
STORPORT_ETW_EVENT_CHANNEL EventChannel,
ULONG EventId,
PWSTR EventDescription,
ULONGLONG EventKeywords,
STORPORT_ETW_LEVEL EventLevel,
STORPORT_ETW_EVENT_OPCODE EventOpcode,
_In_reads_or_z_opt_(STORPORT_ETW_MAX_PARAM_NAME_LENGTH)PWSTR Parameter1Name,
ULONGLONG Parameter1Value,
_In_reads_or_z_opt_(STORPORT_ETW_MAX_PARAM_NAME_LENGTH)PWSTR Parameter2Name,
ULONGLONG Parameter2Value,
_In_reads_or_z_opt_(STORPORT_ETW_MAX_PARAM_NAME_LENGTH)PWSTR Parameter3Name,
ULONGLONG Parameter3Value,
_In_reads_or_z_opt_(STORPORT_ETW_MAX_PARAM_NAME_LENGTH)PWSTR Parameter4Name,
ULONGLONG Parameter4Value,
_In_reads_or_z_opt_(STORPORT_ETW_MAX_PARAM_NAME_LENGTH)PWSTR Parameter5Name,
ULONGLONG Parameter5Value,
_In_reads_or_z_opt_(STORPORT_ETW_MAX_PARAM_NAME_LENGTH)PWSTR Parameter6Name,
ULONGLONG Parameter6Value,
_In_reads_or_z_opt_(STORPORT_ETW_MAX_PARAM_NAME_LENGTH)PWSTR Parameter7Name,
ULONGLONG Parameter7Value,
_In_reads_or_z_opt_(STORPORT_ETW_MAX_PARAM_NAME_LENGTH)PWSTR Parameter8Name,
ULONGLONG Parameter8Value
);
Paramètres
HwDeviceExtension
[in] Pointeur vers l’extension de périphérique matériel pour l’adaptateur de bus hôte (HBA).
ControllerHandle
[in/optional] Pour un miniport NVMe (NVMe-oF), si l’événement est spécifique au contrôleur, ControllerHandle est le handle de Storport pour le contrôleur NVMe ; sinon, la valeur est NULL.
NamespaceId
[in] Si l’événement est spécifique à l’espace de noms, NamespaceId est l’identificateur d’espace de noms ; sinon, il doit être égal à zéro.
EventChannel
[in] Valeur d’énumération STORPORT_ETW_EVENT_CHANNEL qui spécifie le canal ETW où l’événement est journalisé.
EventId
[in] Identificateur d’événement spécifique à Minipoort pour identifier de manière unique le type d’événement.
EventDescription
[in] Chaîne requise qui décrit l’événement. La taille maximale de la chaîne est STORPORT_ETW_MAX_DESCRIPTION_LENGTH caractères, sans inclure la marque de fin Null.
EventKeywords
[in] Masque de bits de STORPORT_ETW_EVENT_CHANNEL_valeurs de XXX pour caractériser davantage l’événement. Définissez la valeur zéro si aucun mot clé n’est nécessaire.
EventLevel
[in] Valeur STORPORT_ETW_LEVEL qui spécifie le niveau de l’événement.
EventOpcode
[in] Valeur d’énumération STORPORT_ETW_EVENT_OPCODE qui spécifie l’opcode de l’événement.
Parameter1Name
[in] Chaîne courte qui donne une signification à Parameter1Value. Si Parameter1Name a la valeur NULL ou une chaîne vide, Parameter1Value est ignoré. La taille maximale de la chaîne est STORPORT_ETW_MAX_PARAM_NAME_LENGTH caractères, sans inclure la marque de fin Null.
Parameter1Value
[in] Valeur du premier paramètre. Si Parameter1Name a la valeur NULL ou une chaîne vide, Storport enregistre cette valeur comme zéro.
Parameter2Name
[in] Chaîne courte qui donne sens à Parameter2Value. Si Paramètre2Name a la valeur NULL ou une chaîne vide, Parameter2Value est ignoré. La taille maximale de la chaîne est STORPORT_ETW_MAX_PARAM_NAME_LENGTH caractères, sans inclure la marque de fin Null.
Parameter2Value
[in] Valeur du deuxième paramètre. Si Parameter2Name a la valeur NULL ou une chaîne vide, Storport enregistre cette valeur comme zéro.
Parameter3Name
[in] Chaîne courte qui donne sens à Parameter3Value. Si Parameter3Name a la valeur NULL ou une chaîne vide, Parameter3Value est ignoré. La taille maximale de la chaîne est STORPORT_ETW_MAX_PARAM_NAME_LENGTH caractères, sans inclure la marque de fin Null.
Parameter3Value
[in] Valeur du troisième paramètre. Si Parameter3Name a la valeur NULL ou une chaîne vide, Storport enregistre cette valeur comme zéro.
Parameter4Name
[in] Chaîne courte qui donne une signification à Parameter4Value. Si Parameter4Name a la valeur NULL ou une chaîne vide, Parameter4Value est ignoré. La taille maximale de la chaîne est STORPORT_ETW_MAX_PARAM_NAME_LENGTH caractères, sans inclure la marque de fin Null.
Parameter4Value
[in] Valeur du quatrième paramètre. Si Parameter4Name a la valeur NULL ou une chaîne vide, Storport enregistre cette valeur comme zéro.
Parameter5Name
[in] Chaîne courte qui donne sens à Parameter5Value. Si Paramètre5Name a la valeur NULL ou une chaîne vide, Parameter5Value est ignoré. La taille maximale de la chaîne est STORPORT_ETW_MAX_PARAM_NAME_LENGTH caractères, sans inclure la marque de fin Null.
Parameter5Value
[in] Valeur du cinquième paramètre. Si Parameter5Name a la valeur NULL ou une chaîne vide, Storport enregistre cette valeur comme zéro.
Parameter6Name
[in] Chaîne courte qui donne une signification à Parameter6Value. Si Parameter6Name a la valeur NULL ou une chaîne vide, Parameter6Value est ignoré. La taille maximale de la chaîne est STORPORT_ETW_MAX_PARAM_NAME_LENGTH caractères, sans inclure la marque de fin Null.
Parameter6Value
[in] Valeur du sixième paramètre. Si Parameter6Name a la valeur NULL ou une chaîne vide, Storport enregistre cette valeur comme zéro.
Parameter7Name
[in] Chaîne courte qui donne une signification à Parameter7Value. Si Parameter7Name a la valeur NULL ou une chaîne vide, Parameter7Value est ignoré. La taille maximale de la chaîne est STORPORT_ETW_MAX_PARAM_NAME_LENGTH caractères, sans inclure la marque de fin Null.
Parameter7Value
[in] Valeur du septième paramètre. Si Parameter7Name a la valeur NULL ou une chaîne vide, Storport enregistre cette valeur comme zéro.
Parameter8Name
[in] Chaîne courte qui donne une signification à Parameter8Value. Si Parameter8Name a la valeur NULL ou une chaîne vide, Parameter8Value est ignoré. La taille maximale de la chaîne est STORPORT_ETW_MAX_PARAM_NAME_LENGTH caractères, sans inclure la marque de fin Null.
Parameter8Value
[in] Valeur du huitième paramètre. Si Parameter8Name a la valeur NULL ou une chaîne vide, Storport enregistre cette valeur comme zéro.
Valeur de retour
StorPortNvmeMiniportEvent retourne un STOR_STATUS_SUCCESS si l’événement est correctement journalisé. Sinon, elle retourne une valeur telle que :
| Retourner le code | Description |
|---|---|
| STOR_STATUS_NOT_IMPLEMENTED | Cette fonction n’est pas implémentée sur le système d’exploitation actif. |
| STOR_STATUS_INVALID_PARAMETER | L’opération échoue avec cette valeur de retour si un ou plusieurs des paramètres ne sont pas valides. |
| STOR_STATUS_UNSUCCESSFUL | L’opération a échoué pour d’autres raisons internes. |
Remarques
Un miniport peut appeler StorPortNvmeMiniportEvent pour consigner huit paramètres ETW universels. Les paramètres ETW sont exprimés sous forme de huit paires nom-valeur. Si un paramètre n’est pas nommé (ParamètreXName = NULL), la routine définit la valeur de paramètre correspondante sur 0.
Les événements générés à partir de pilotes miniport StorPort sont enregistrés dans le canal spécifié par EventChannel.
Exigences
| Exigence | Valeur |
|---|---|
| client minimum pris en charge | Windows 11, version 24H2 |
| d’en-tête | storport.h |