dsetup.h

Go to the documentation of this file.

/*==========================================================================
 *
 *  Copyright (C) 1995-1997 Microsoft Corporation.  All Rights Reserved.
 *
 *  File:       dsetup.h
 *  Content:    DirectXSetup, error codes and flags
 ***************************************************************************/
 
#ifndef __DSETUP_H__
#define __DSETUP_H__
 
#include <windows.h>      // windows stuff
 
#ifdef _WIN32
#define COM_NO_WINDOWS_H
#include <objbase.h>
#else
#endif
 
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define DSETUPERR_SUCCESS_RESTART        1 
#define DSETUPERR_SUCCESS                0 
#define DSETUPERR_BADWINDOWSVERSION     -1 
#define DSETUPERR_SOURCEFILENOTFOUND    -2 
#define DSETUPERR_BADSOURCESIZE         -3 
#define DSETUPERR_BADSOURCETIME         -4 
#define DSETUPERR_NOCOPY                -5 
#define DSETUPERR_OUTOFDISKSPACE        -6 
#define DSETUPERR_CANTFINDINF           -7 
#define DSETUPERR_CANTFINDDIR           -8 
#define DSETUPERR_INTERNAL              -9 
#define DSETUPERR_NTWITHNO3D            -10 
#define DSETUPERR_UNKNOWNOS             -11 
#define DSETUPERR_USERHITCANCEL         -12 
#define DSETUPERR_NOTPREINSTALLEDONNT   -13 
 
#define DSETUP_DDRAWDRV         0x00000008      
#define DSETUP_DSOUNDDRV        0x00000010      
#define DSETUP_DXCORE           0x00010000  
#define DSETUP_DIRECTX  (DSETUP_DXCORE|DSETUP_DDRAWDRV|DSETUP_DSOUNDDRV) 
#define DSETUP_TESTINSTALL      0x00020000      
 
// TODO: In the official doc, all of these say DX3 programs that use this will install all DX components. Does this mean doing one of these will necessitate installing all DX components?
#define DSETUP_DDRAW            0x00000001      
#define DSETUP_DSOUND           0x00000002      
#define DSETUP_DPLAY            0x00000004      
#define DSETUP_DPLAYSP          0x00000020      
#define DSETUP_DVIDEO           0x00000040      
#define DSETUP_D3D              0x00000200      
#define DSETUP_DINPUT           0x00000800      
#define DSETUP_DIRECTXSETUP     0x00001000      
#define DSETUP_NOUI             0x00002000      
#define DSETUP_PROMPTFORDRIVERS 0x10000000      
#define DSETUP_RESTOREDRIVERS   0x20000000      
 
 
 
//******************************************************************
// DirectX Setup Callback mechanism
//******************************************************************
 
#define DSETUP_CB_MSG_NOMESSAGE                     0 
#define DSETUP_CB_MSG_CANTINSTALL_UNKNOWNOS         1 
#define DSETUP_CB_MSG_CANTINSTALL_NT                2 
#define DSETUP_CB_MSG_CANTINSTALL_BETA              3 
#define DSETUP_CB_MSG_CANTINSTALL_NOTWIN32          4 
#define DSETUP_CB_MSG_CANTINSTALL_WRONGLANGUAGE     5 
#define DSETUP_CB_MSG_CANTINSTALL_WRONGPLATFORM     6 
#define DSETUP_CB_MSG_PREINSTALL_NT                 7 
#define DSETUP_CB_MSG_NOTPREINSTALLEDONNT           8 
#define DSETUP_CB_MSG_SETUP_INIT_FAILED             9 
#define DSETUP_CB_MSG_INTERNAL_ERROR                10 
#define DSETUP_CB_MSG_CHECK_DRIVER_UPGRADE          11 
#define DSETUP_CB_MSG_OUTOFDISKSPACE                12 
#define DSETUP_CB_MSG_BEGIN_INSTALL                 13 
#define DSETUP_CB_MSG_BEGIN_INSTALL_RUNTIME         14 
#define DSETUP_CB_MSG_BEGIN_INSTALL_DRIVERS         15 
#define DSETUP_CB_MSG_BEGIN_RESTORE_DRIVERS         16 
#define DSETUP_CB_MSG_FILECOPYERROR                 17 
 
 
#define DSETUP_CB_UPGRADE_TYPE_MASK             0x000F 
#define DSETUP_CB_UPGRADE_UNNECESSARY           0x000F 
#define DSETUP_CB_UPGRADE_KEEP                  0x0001 
#define DSETUP_CB_UPGRADE_SAFE                  0x0002 
#define DSETUP_CB_UPGRADE_FORCE                 0x0004 
#define DSETUP_CB_UPGRADE_UNKNOWN               0x0008 
 
#define DSETUP_CB_UPGRADE_HASWARNINGS           0x0100 
#define DSETUP_CB_UPGRADE_CANTBACKUP            0x0200 
 
#define DSETUP_CB_UPGRADE_DEVICE_ACTIVE         0x0800 
 
#define DSETUP_CB_UPGRADE_DEVICE_DISPLAY        0x1000 
#define DSETUP_CB_UPGRADE_DEVICE_MEDIA          0x2000 
 
typedef struct _DSETUP_CB_UPGRADEINFO
{
    DWORD UpgradeFlags; 
} DSETUP_CB_UPGRADEINFO;
 
typedef struct _DSETUP_CB_FILECOPYERROR
{
    DWORD dwError; 
} DSETUP_CB_FILECOPYERROR;
 
 
//
// Data Structures
//
typedef struct _DIRECTXREGISTERAPPA {
    DWORD    dwSize; 
    DWORD    dwFlags; 
    LPSTR    lpszApplicationName; 
    LPGUID   lpGUID; 
    LPSTR    lpszFilename; 
    LPSTR    lpszCommandLine; 
    LPSTR    lpszPath; 
    LPSTR    lpszCurrentDirectory; 
} DIRECTXREGISTERAPPA, *PDIRECTXREGISTERAPPA, *LPDIRECTXREGISTERAPPA;
 
typedef struct _DIRECTXREGISTERAPPW {
    DWORD    dwSize; 
    DWORD    dwFlags; 
    LPWSTR    lpszApplicationName; 
    LPGUID   lpGUID; 
    LPWSTR    lpszFilename; 
    LPWSTR    lpszCommandLine; 
    LPWSTR    lpszPath; 
    LPWSTR    lpszCurrentDirectory; 
} DIRECTXREGISTERAPPW, *PDIRECTXREGISTERAPPW, *LPDIRECTXREGISTERAPPW;
 
typedef DIRECTXREGISTERAPPW DIRECTXREGISTERAPP;
typedef PDIRECTXREGISTERAPPW PDIRECTXREGISTERAPP;
typedef LPDIRECTXREGISTERAPPW LPDIRECTXREGISTERAPP;
typedef DIRECTXREGISTERAPPA DIRECTXREGISTERAPP;
typedef PDIRECTXREGISTERAPPA PDIRECTXREGISTERAPP;
typedef LPDIRECTXREGISTERAPPA LPDIRECTXREGISTERAPP;
#endif // UNICODE
 
 
//
// API
//
INT
WINAPI
DirectXSetupA(
    HWND  hWnd, 
    LPSTR lpszRootPath, 
    DWORD dwFlags 
    );
INT
WINAPI
DirectXSetupW(
    HWND   hWnd, 
    LPWSTR lpszRootPath, 
    DWORD  dwFlags  
    );
 
#define DirectXSetup  DirectXSetupW
#define DirectXSetup  DirectXSetupA
 
INT
WINAPI
DirectXDeviceDriverSetupA(
    HWND  hWnd,
    LPSTR lpszDriverClass,
    LPSTR lpszDriverPath,
    DWORD dwFlags
    );
 
INT
WINAPI
DirectXDeviceDriverSetupW(
    HWND   hWnd,
    LPWSTR lpszDriverClass,
    LPWSTR lpszDriverPath,
    DWORD  dwFlags
    );
#define DirectXDeviceDriverSetup  DirectXDeviceDriverSetupW
#define DirectXDeviceDriverSetup  DirectXDeviceDriverSetupA
 
 
INT
WINAPI
DirectXRegisterApplicationA(
    HWND                  hWnd, 
    LPDIRECTXREGISTERAPPA lpDXRegApp 
    );
INT
WINAPI
DirectXRegisterApplicationW(
    HWND                  hWnd, 
    LPDIRECTXREGISTERAPPA lpDXRegApp 
    );
 
#define DirectXRegisterApplication  DirectXRegisterApplicationW
#define DirectXRegisterApplication  DirectXRegisterApplicationA
 
INT
WINAPI
DirectXUnRegisterApplication(
    HWND     hWnd, 
    LPGUID   lpGUID 
    );
 
//
// Function Pointers
//
typedef INT (WINAPI * LPDIRECTXSETUP)(HWND, LPWSTR, DWORD);
typedef INT (WINAPI * LPDIRECTXDEVICEDRIVERSETUP)(HWND, LPWSTR, LPSTR, DWORD);
typedef INT (WINAPI * LPDIRECTXREGISTERAPPLICATION)(HWND, LPDIRECTXREGISTERAPPW);
typedef INT (WINAPI * LPDIRECTXSETUP)(HWND, LPSTR, DWORD);
typedef INT (WINAPI * LPDIRECTXDEVICEDRIVERSETUP)(HWND, LPSTR, LPSTR, DWORD);
typedef INT (WINAPI * LPDIRECTXREGISTERAPPLICATION)(HWND, LPDIRECTXREGISTERAPPA);
#endif
 
// Microsoft did this in the header file for DirectXSetupCallbackFunction - it is a placeholder after all.
// typedef DWORD (FAR PASCAL * DSETUP_CALLBACK)(DWORD Reason,
//                                   DWORD MsgType,       /*! Same as flags to MessageBox */
//                                   LPSTR szMessage,
//                                   LPSTR szName,
//                                   void *pInfo);
 
// Here is the reconstructed thing. In the docs LPSTR is shown as char*, but its the same thing
 
DWORD DirectXSetupCallbackFunction(
    DWORD Reason, 
    DWORD MsgType, 
    LPSTR *szMessage, 
    LPSTR *szName, 
    void *pInfo 
)
 
 
INT WINAPI DirectXSetupSetCallback(DSETUP_CALLBACK Callback);
 
INT WINAPI DirectXSetupGetVersion(DWORD *lpdwVersion, DWORD *lpdwMinorVersion);
 
 
#ifdef __cplusplus
};
#endif
 
#endif