SQLPostInstallerError Function

Conformance
Version Introduced: ODBC 3.0

Summary
SQLPostInstallerError provides a mechanism for a driver or translator setup library to report errors for the ConfigDriver, ConfigDSN, and ConfigTranslator functions to the installer error queue. Applications do not use this API; they use SQLInstallerError to retrieve the error.

Syntax

  
RETCODE SQLPostInstallerError(  
     DWORD    fErrorCode,  
     LPSTR    szErrorMsg);  

Arguments

fErrorCode
[Input] Installer error code.

szErrorMsg
[Input] Error message text.

Returns

SQL_SUCCESS or SQL_ERROR.

Diagnostics

SQLPostInstallerError does not post error values for itself. If the error was successfully posted to the installer error queue (retrievable using SQLInstallerError), SQL_SUCCESS is returned. SQL_ERROR will be returned if the value in the dwErrorCode argument is not one of the specified installer error codes.

Related Functions