Edit

STORPORT_TELEMETRY_EVENT structure (storport.h)

  • Article

The STORPORT_TELEMETRY_EVENT structure describes the miniport telemetry data payload.

Syntax

typedef struct _STORPORT_TELEMETRY_EVENT {
  ULONG     DriverVersion;
  ULONG     EventId;
  UCHAR     EventName[EVENT_NAME_MAX_LENGTH];
  ULONG     EventVersion;
  ULONG     Flags;
  ULONG     EventBufferLength;
  PUCHAR    EventBuffer;
  UCHAR     ParameterName0[EVENT_MAX_PARAM_NAME_LEN];
  ULONGLONG ParameterValue0;
  UCHAR     ParameterName1[EVENT_MAX_PARAM_NAME_LEN];
  ULONGLONG ParameterValue1;
  UCHAR     ParameterName2[EVENT_MAX_PARAM_NAME_LEN];
  ULONGLONG ParameterValue2;
  UCHAR     ParameterName3[EVENT_MAX_PARAM_NAME_LEN];
  ULONGLONG ParameterValue3;
  UCHAR     ParameterName4[EVENT_MAX_PARAM_NAME_LEN];
  ULONGLONG ParameterValue4;
  UCHAR     ParameterName5[EVENT_MAX_PARAM_NAME_LEN];
  ULONGLONG ParameterValue5;
  UCHAR     ParameterName6[EVENT_MAX_PARAM_NAME_LEN];
  ULONGLONG ParameterValue6;
  UCHAR     ParameterName7[EVENT_MAX_PARAM_NAME_LEN];
  ULONGLONG ParameterValue7;
} STORPORT_TELEMETRY_EVENT, *PSTORPORT_TELEMETRY_EVENT;

Members

DriverVersion

Miniport driver version.

EventId

A miniport defined identifier for the telemetry event.

EventName[EVENT_NAME_MAX_LENGTH]

A miniport defined name for the telemetry event, which has the maximum length of EVENT_NAME_MAX_LENGTH.

EventVersion

A miniport defined version for the telemetry event.

Flags

Reserved.

EventBufferLength

The length of EventBuffer, which should be not larger than EVENT_BUFFER_MAX_LENGTH that is 4KB.

EventBuffer

A miniport defined telemetry payload, the length of which is EventBufferLength.

ParameterName0[EVENT_MAX_PARAM_NAME_LEN]

A description of the of the meaning of ParameterValue0. This parameter name string must be <= EVENT_MAX_PARAM_NAME_LEN.

ParameterValue0

The value for parameter 0.

ParameterName1[EVENT_MAX_PARAM_NAME_LEN]

A description of the of the meaning of ParameterValue1. This parameter name string must be <= EVENT_MAX_PARAM_NAME_LEN.

ParameterValue1

The value for parameter 1.

ParameterName2[EVENT_MAX_PARAM_NAME_LEN]

A description of the of the meaning of ParameterValue2. This parameter name string must be <= EVENT_MAX_PARAM_NAME_LEN.

ParameterValue2

The value for parameter 2.

ParameterName3[EVENT_MAX_PARAM_NAME_LEN]

A description of the of the meaning of ParameterValue3. This parameter name string must be <= EVENT_MAX_PARAM_NAME_LEN.

ParameterValue3

The value for parameter 3.

ParameterName4[EVENT_MAX_PARAM_NAME_LEN]

A description of the of the meaning of ParameterValue4. This parameter name string must be <= EVENT_MAX_PARAM_NAME_LEN.

ParameterValue4

The value for parameter 4.

ParameterName5[EVENT_MAX_PARAM_NAME_LEN]

A description of the of the meaning of ParameterValue5. This parameter name string must be <= EVENT_MAX_PARAM_NAME_LEN.

ParameterValue5

The value for parameter 5.

ParameterName6[EVENT_MAX_PARAM_NAME_LEN]

A description of the of the meaning of ParameterValue6. This parameter name string must be <= EVENT_MAX_PARAM_NAME_LEN.

ParameterValue6

The value for parameter 6.

ParameterName7[EVENT_MAX_PARAM_NAME_LEN]

A description of the of the meaning of ParameterValue7. This parameter name string must be <= EVENT_MAX_PARAM_NAME_LEN.

ParameterValue7

The value for parameter 7.

Remarks

A STORPORT_TELEMETRY_EVENT structure describes the miniport telemetry data payload. The miniport should fill it when calling StorPortLogTelemetry.

Requirements

Requirement Value
Minimum supported client Windows 10, version 1703
Minimum supported server Windows Server 2016
Header storport.h (include Storport.h)

See also

StorPortLogTelemetry