SplPdGetPortIcon: Difference between revisions
Created page with "SplPdGetPortIcon queries the Resource ID of the icon that represents the port. == Syntax == SplPdGetPortIcon(hab, idIcon); == Parameters == ; hab (HAB) - input : The hand..." |
m →Remarks |
||
| (One intermediate revision by the same user not shown) | |||
| Line 1: | Line 1: | ||
SplPdGetPortIcon queries the Resource ID of the icon that represents the port. | SplPdGetPortIcon queries the Resource ID of the icon that represents the port. | ||
== Syntax == | == Syntax == | ||
| Line 5: | Line 5: | ||
== Parameters == | == 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 == | == 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. | |||
== Remarks == | == 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 | 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. | |||
[[Category:Spl]] | [[Category:Spl]] | ||
Latest revision as of 04:28, 12 January 2021
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.