Click above to get retro games delivered to your door ever month!

 BLIMGRSTS()
------------------------------------------------------------------------------
 Purpose:
 Get program status information.

 Syntax:
 nlValue = BLIMGRSTS(niOption)

 Parameters:
 niOption  Status information option number.

 Returns:
 Various.

 Description:
 BLIMGRSTS() is a multi-purpose function which can be used to obtain status
 information concerning the currently executing program and environment.

 This function can be called from most languages using the normal calling
 conventions for the language being used. BLIMGRSTS() takes a single
 parameter - an option number indicating the status information required.
 Information that is undefined in the current environment will be returned as
 zero (e.g. cache size in a protected mode program).

 The constant parameters to BLIMGRSTS() are defined in the header files
 BLINKER.*. The values currently defined are :

 BliHostMode      Get DOS extender host mode (DPMI/VCPI/XMS)
 BliMachineMode   Get current machine mode (real, protected)
 BliCacheLoc      Get location of real mode overlay cache (EMS/XMS)
 BliCacheSize     Get size of overlay cache
 BliOverlayLoc    Get location of overlay area
 BliOverlaySize   Get size of overlay area
 BliExtMemAvail   Get bytes extended memory available to the extender
 BliRealMemAvail  Get bytes real memory available to the extender
 BliVirMemAvail   Get bytes virtual memory available to the extender

 Example:
 // Get processor and overlay cache status                                   
 //                                                                          
 if (BLIMGRSTS(BliMachineMode) = BliModeReal)                                
    ? "Running in real mode"                                                 
    cacheloc = BLIMGRSTS(BliCacheLoc)                                        
    do case                                                                  
    case cacheloc = BliCacheNone                                             
       ? "No cache available"                                                
    case cacheloc = BliCacheXMS                                              
       ? "Cache is in XMS"                                                   
    case cacheloc = BliCacheEMS                                              
       ? "Cache is in EMS"                                                   
    endcase                                                                  
 else                                                                        
    ? "Running in protected mode"                                            
    hosttype = BLIMGRSTS(BliHostMode)                                        
    ? "DOS extender host is : "                                              
    do case                                                                  
    case hosttype = BliHostDPMI                                              
       ?? "DPMI"                                                             
    case hosttype = BliHostVCPI                                              
       ?? "VCPI"                                                             
    case hosttype = BliHostXMS                                               
       ?? "XMS"                                                              
    endcase                                                                  
 endif