Jump to content

SplPdInstallPort

From EDM2
Revision as of 18:28, 2 July 2023 by Ak120 (talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

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.