GetDescriptor method of the Win32_USBHub class

The GetDescriptor method returns the USB hub descriptor as specified by the input parameters.

[!Important]
The DMTF (Distributed Management Task Force) CIM (Common Information Model) classes are the parent classes upon which WMI classes are built. WMI currently supports only the CIM 2.x version schemas.

This topic uses Managed Object Format (MOF) syntax. For more information about using this method, see Calling a Method.

Syntax

uint32 GetDescriptor(
  [in]      uint8  RequestType,
  [in]      uint16 RequestValue,
  [in]      uint16 RequestIndex,
  [in, out] uint16 RequestLength,
  [out]     uint8  Buffer[]
);

Parameters

RequestType [in]

Bit-mapped identifier for the type of descriptor request and the recipient. For the appropriate values for each bit, see the USB specification.

RequestValue [in]

Contains the descriptor type in the high byte and the descriptor index (for example, index or offset into the descriptor array) in the low byte. For more information, see the USB specification.

RequestIndex [in]

Specifies the 2-byte language identifier code used by the USB device when returning string descriptor data. The parameter is typically 0 (zero) for nonstring descriptors. For more information, see the USB specification.

RequestLength [in, out]

On input, the length (in octets) of the descriptor that should be returned. If this value is less than the actual length of the descriptor, only the requested length is returned. If it is more than the actual length, the actual length is returned.

On output, the length (in octets) of the buffer being returned. If the requested descriptor does not exist, the contents of this parameter are undefined.

Buffer [out]

Buffer returns the requested descriptor information. If the descriptor does not exist, the contents of the buffer are undefined.

Return value

Returns a value of 0 (zero) if the USB descriptor is successfully returned, 1 (one) if the request is not supported, and any other number to indicate an error. In a subclass, the set of possible return codes could be specified by using a ValueMap qualifier on the method. The strings to which the mofqualifier contents are translated can also be specified in the subclass as a Values array qualifier.

Remarks

This method is currently not implemented by WMI. To use this method, you must implement it in your own provider. For more information, see Providing Data to WMI.

This documentation is derived from the CIM class descriptions published by the DMTF. Microsoft may have made changes to correct minor errors, conform to Microsoft SDK documentation standards, or provide more information.

Requirements

See also

CIM_USBHub

Win32_USBHub