PwmParsePinPath function (pwmutil.h)

Parses a pin path under the Pulse Width Modulation (PWM) controller namespace to validate its format and extract the pin number.

Syntax

NTSTATUS PwmParsePinPath(
  [in]            UNICODE_STRING *PinPath,
  [out, optional] ULONG          *PinNumber
);

[in] PinPath

A pointer to pin path as a Unicode character string.

[out, optional] PinNumber

A pointer to variable that receives a pin number.

PwmParsePinPath returns the following values:

Return code	Description
STATUS_SUCCESS	Extracted pin path successfully from supplied pin path.
STATUS_INVALID_PARAMETER	The specified pin path pointer is invalid or its Unicode string is invalid.
STATUS_NO_SUCH_FILE	The specified pin path does not constitute a valid pin path.

The pin path must be a Unicode character string that ends in the pin number as follows: ...<PinNumber>.