PEP_PPM_QUERY_VETO_REASON structure (pepfx.h)

The PEP_PPM_QUERY_VETO_REASON structure supplies a wide-character, null-terminated string that contains a descriptive, human-readable name for a veto reason.

Syntax

typedef struct _PEP_PPM_QUERY_VETO_REASON {
  [in]  ULONG  VetoReason;
  [out] USHORT NameSize;
  [in]  PWSTR  Name;
} PEP_PPM_QUERY_VETO_REASON, *PPEP_PPM_QUERY_VETO_REASON;

Members

[in] VetoReason

The index that identifies this veto reason. If the platform extension plug-in (PEP) supports N veto reasons, valid veto reason indexes range from 1 to N. The PEP previously specified the number of supported veto reasons in response to a PEP_NOTIFY_PPM_QUERY_VETO_REASONS notification.

[out] NameSize

The size, in bytes, of the string buffer pointed to by the Name member. This string size includes the storage space for the null character that terminates the wide-character string.

[in] Name

A pointer to a PoFx-allocated string buffer. If this buffer pointer is non-NULL, the PEP writes a wide-character, null-terminated string to the buffer (and writes nothing to the NameSize member). Otherwise, the PEP writes nothing to this buffer and instead writes the required string size to the NameSize member.

Remarks

This structure is used by the PEP_NOTIFY_PPM_QUERY_VETO_REASON notification. The VetoReason and Name members contain input values that are supplied by the Windows power management framework (PoFx). If the input value of the Name member is NULL, the PEP writes an output value (the required string buffer size) to the NameSize member.

Requirements

Requirement	Value
Minimum supported client	Supported starting with Windows 10.
Header	pepfx.h (include Pep_x.h)

See also

PEP_NOTIFY_PPM_QUERY_VETO_REASON

PEP_NOTIFY_PPM_QUERY_VETO_REASONS