DspSetDriverInfo
Appearance
This function is used to set PM display driver configuration parameters.
Syntax
DspSetDriverInfo(pDSPInfo, flOptions)
Parameters
- pDSPInfo (PDSPINFO) - input
- Pointer to a PDSPINFO data structure.
- Pointer to a PDSPINFO data structure that contains the following values:
- pszDriverName
- A NULL-terminated string containing the name of the driver. All IBM drivers should start with "IBM", as in IBMVGA or IBMXGA.
- cchDriverName
- Length of the pszDriverName buffer.
- pszDesc
- Pointer to a string describing the driver. This description is used by the program that lists the available drivers and that gives information as to which driver is loaded.
- cchDesc
- Length of the pszDesc buffer.
- pszFileName
- The fully qualified path name (drive, path, and file name) of the display driver DLL.
- cchFileName
- Length of the pszFileName buffer.
- pszOptionalParameters
- Pointer to a string of optional parameters, which might be known only to the device driver.
- cchOptionalParameters
- Length of the pszOptionalParameters buffer.
- flOptions (ULONG) - input
- The following flags are used to specify various options:
- DSP_DELETE_DRIVER: Completely delete the driver information from the INI file.
- DSP_OPT_PARMS_PRESENT: Optional parameters are present. The default does not use optional parameters. If this flag is not set, pszOptionalParameters is ignored and can be NULL.
- DSP_SET_DEFAULT_DRIVER: Make this driver the default system display driver.
- DSP_SET_INSTALL_ON_IPL: Install this driver as the current system display driver at next startup.
Return Code
- fSuccess (BOOL) - returns
- Return codes.
- On completion, this installation routine must return BOOLEAN (fSuccess).
- TRUE Success, no error
- FALSE NULL, error occurred
Possible Errors Detected: When an error is detected, the handling routine must call WinGetLastError to post the condition. Error codes for conditions that the handling routine is expected to check are:
- PMERR_CURRENT_SYSTEM_DRIVER
- PMERR_INVALID_PARAMETER
- PMERR_MEMORY_ALLOC
- PMERR_MEMORY_ALLOCATION_ERR
- PMERR_MEMORY_DEALLOCATION_ERR
Remarks
The call is used to register display drivers with the operating system (informing the operating system of the existence and location of the drivers). It can be used to mark a display driver as the system's current display driver or the system's default display driver. If the DSP_DELETE_DRIVER flag is set, all of the information for a given driver is deleted and the pDSPInfo parameter is ignored.