This documentation is archived and is not being maintained.

ISideShowDriver::OnGetDeviceEndpoints method

Retrieves the list of endpoints that a device supports.

Syntax


HRESULT OnGetDeviceEndpoints(
  [out] ENDPOINT_ID **rgEndpoints,
  [out] DWORD       *pcEndpoints
);

Parameters

rgEndpoints [out]

A pointer that receives an array of endpoints. OnGetDeviceEndpoints should call the CoTaskMemAlloc function (described in the Microsoft Windows SDK documentation) to allocate memory space for the array. When the caller no longer requires the array, the caller must free the array.

pcEndpoints [out]

A pointer to a variable that receives the number of endpoints in the array that the rgEndpoints parameter receives.

Return value

The OnGetDeviceEndpoints method returns S_OK if the operation succeeds. Otherwise, this method returns one of the error codes that are defined in Winerror.h.

Remarks

For devices that are glance data only, the list returned in the rgEndpoints parameter should contain all endpoints that glance-text will be displayed for.

Requirements

Target platform

Desktop

Header

Windowssideshowclassextension.h (include WindowsSideShowClassExtension.h)

 

 

Send comments about this topic to Microsoft

Show: