MgslSetPortConfig


Prototype  
ULONG MgslSetPortConfig( ULONG PortID,
                         PMGSL_PORT_CONFIG pConfig );
Parameters  
PortID
Integer port identifier
pConfig
pointer to MGSL_PORT_CONFIG structure which describes a SyncLink adapter hardware settings
Return Value  
ERROR_SUCCESS (0)
parameter set successful
ERROR_INVALID_PARAMETER
error in MGSL_PORT_CONFIG structure.
ERROR_ACCESS_DENIED
use has insufficient privilege

NOTE: This function is obsolete, new applications should use MgslSetPortConfigEx.

Configures a SyncLink adapter port hardware settings. The hardware settings are specified with the MGSL_PORT_CONFIG structure. The settings are stored in the registry, with the location dependent on the platform. Calling this function on Windows NT requires the user to have administrative privilege.

Calling MgslSetPortConfig with a MGSL_PORT_CONFIG structure alters an existing port configuration or adds a new port configuration. Calling MgslSetPortConfig with pConfig set to NULL deletes an existing port configuration. When starting, the device driver attempts to initialize all configured ports. If a port fails to initialize then an error is reported. If an adapter is removed from the system, then the port configuration should also be removed to prevent errors from being reported.

In most cases the port configuration is handled through the control panel applet supplied with the run time kit. If the API programmer wishes to move the port configuration into a custom application then this API call provides a standard platform independent method of setting the configuration.

See also: Configuring the Port, MgslGetPortConfig


Previous Contents Next