SQLInstallerError.md

Home

Function name : SQLInstallerError

Group: ODBC API - Library: odbccp32

---

SQLInstallerError returns error or status information for the ODBC installer functions.

---

Code examples:

How to display a dialog box with which the user can add a data source (DSN)
Adding an ODBC data source with the SQLConfigDataSource; use automatic or interactive mode

Declaration:

RETCODE SQLInstallerError(
	WORD iError,
	DWORD * pfErrorCode,
	LPSTR lpszErrorMsg,
	WORD cbErrorMsgMax,
	WORD * pcbErrorMsg
);  

---

FoxPro declaration:

DECLARE INTEGER SQLInstallerError IN odbccp32;
	INTEGER   iError,;
	INTEGER @ pfErrorCode,;
	STRING  @ lpszErrorMsg,;
	INTEGER   cbErrorMsgMax,;
	INTEGER @ pcbErrorMsg
  

---

Parameters:

iError [Input] Error record number. Valid numbers are from 1 through 8.

pfErrorCode [Output] Installer error code.

lpszErrorMsg [Output] Pointer to storage for the error message text.

cbErrorMsgMax [Input] Maximum length of the szErrorMsg buffer.

cbErrorMsgMax [Input] Maximum length of the szErrorMsg buffer.

pcbErrorMsg [Output] Pointer to the total number of bytes available to return in lpszErrorMsg.

---

Return value:

SQL_SUCCESS (0), SQL_SUCCESS_WITH_INFO, SQL_NO_DATA, or SQL_ERROR.

---