SplPdInstallPort: Difference between revisions
Created page with "SplPdInstallPort tells the port driver the name of the port that needs to be installed. == Syntax == SplPdInstallPort(hab, pszPortName); == Parameters == ; hab (HAB) - in..." |
mNo edit summary |
||
| Line 1: | Line 1: | ||
SplPdInstallPort tells the port driver the name of the port that needs to be installed. | SplPdInstallPort tells the port driver the name of the port that needs to be installed. | ||
== Syntax == | == Syntax == | ||
SplPdInstallPort(hab, pszPortName) | SplPdInstallPort(hab, pszPortName) | ||
== Parameters == | == Parameters == | ||
; hab (HAB) - input : The handle to anchor block. | ;hab (HAB) - input : The handle to anchor block. | ||
;pszPortName (PSZ) - input : The name of the port to be installed. | |||
; pszPortName (PSZ) - input : The name of the port to be installed. | |||
== Returns == | == Returns == | ||
; rc (APIERR) - returns : Return codes. | ;rc (APIERR) - returns : Return codes. | ||
:This handling routine returns the following errors: | |||
This handling routine returns the following errors: | ::ERROR_INVALID_PARAMETER | ||
::NO_ERROR | |||
== Sample == | == Sample == | ||
| Line 26: | Line 23: | ||
rc = SplPdInstallPort(hab, pszPortName); | rc = SplPdInstallPort(hab, pszPortName); | ||
</pre> | </pre> | ||
== Remarks == | == Remarks == | ||
This function is called from the Workplace Shell. The port driver writes the initialization data from the INI file. The Workplace Shell then typically calls SplPdSetPort. | This function is called from the Workplace Shell. The port driver writes the initialization data from the INI file. The Workplace Shell then typically calls [[SplPdSetPort]]. | ||
[[Category:Spl]] | [[Category:Spl]] | ||
Latest revision as of 18:28, 2 July 2023
SplPdInstallPort tells the port driver the name of the port that needs to be installed.
Syntax
SplPdInstallPort(hab, pszPortName)
Parameters
- hab (HAB) - input
- The handle to anchor block.
- pszPortName (PSZ) - input
- The name of the port to be installed.
Returns
- rc (APIERR) - returns
- Return codes.
- This handling routine returns the following errors:
- ERROR_INVALID_PARAMETER
- NO_ERROR
Sample
#include <os2.h> HAB hab; /* The handle to anchor block. */ PSZ pszPortName; /* The name of the port to be installed. */ APIERR rc; /* Return codes. */ rc = SplPdInstallPort(hab, pszPortName);
Remarks
This function is called from the Workplace Shell. The port driver writes the initialization data from the INI file. The Workplace Shell then typically calls SplPdSetPort.