SplPdGetPortIcon

SplPdGetPortIcon queries the Resource ID of the icon that represents the port.

Syntax
SplPdGetPortIcon(hab, idIcon);

Parameters

 * hab (HAB) - input : The handle to the anchor block.


 * idIcon (PULONG) - input : The resource ID of the icon bit map.

Returns

 * rc (BOOL) - returns : Return codes.

This handling routine returns FALSE if no icon is available. The system then uses a default port icon.

Sample

 * 1) include 

HAB      hab;     /*  The handle to the anchor block. */ PULONG   idIcon;  /*  The resource ID of the icon bit map. */ BOOL     rc;      /*  Return codes. */

rc = SplPdGetPortIcon(hab, idIcon);

Remarks
Only one icon is used for all the ports supported by a port driver. This limitation is imposed to avoid confusing the user with too many different icons.

The Workplace Shell calls SplQpQueryIcon to load and draw port icons, as appropriate.