SplPdGetPortIcon: Difference between revisions

Revision as of 22:16, 7 June 2020

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.

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.

@@ Line 1: / Line 1: @@
 SplPdGetPortIcon queries the Resource ID of the icon that represents the port.
 == Syntax ==
@@ Line 5: / Line 5: @@
 == Parameters ==
-; hab (HAB) - input : The handle to the anchor block.
+;hab (HAB) - input : The handle to the anchor block.
+;idIcon (PULONG) - input : The resource ID of the icon bit map.
-; idIcon (PULONG) - input : The resource ID of the icon bit map.
 == Returns ==
-; rc (BOOL) - returns : Return codes.
+;rc (BOOL) - returns : Return codes.
+This handling routine returns FALSE if no icon is available. The system then uses a default port icon.
-This handling routine returns FALSE if no icon is available. The system then uses a default port icon.
-== Sample ==
-<pre>
-#include <os2.h>
-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);
-</pre>
 == 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.
+The Workplace Shell calls [[SplQpQueryIcon]] to load and draw port icons, as appropriate.
 [[Category:Spl]]