PropKeyFindKeyGetNthUshort function (sensorsutils.h)

This routine gets the nth USHORT value from a PROPVARIANT within a collection list based on the PROPERTYKEY.

Syntax

NTSTATUS PropKeyFindKeyGetNthUshort(
  [in]  const SENSOR_COLLECTION_LIST *pList,
  [in]  const PROPERTYKEY            *pKey,
  [in]  const UINT32                 Occurrence,
  [out] USHORT                       *pRetValue
);

Parameters

[in] pList

Pointer to the list of PROPVARIANT collection.

[in] pKey

Pointer to a PROPERTYKEY for the target PROPVARIANT

[in] Occurrence

Zero-based number of occurrence the PROPERTYKEY must be found before returning the value.

[out] pRetValue

Pointer to the output buffer.

Return value

This function returns one of the following NTSTATUS codes:

• STATUS_INVALID_PARAMETER if pList, pKey or, pRetValue is nullptr.
• STATUS_NOT_FOUND if the element at Occurrence was not found.
• STATUS_SUCCESS on success.

Requirements