DiveSwitchBank

This function selects the VRAM bank for bank-switched displays.

Syntax

_DiveSwitchBank(hDiveInst, ulBankNumber)

Parameters

hDiveInst (HDIVE) - input

Display engine DIVE instance.

ulBankNumber (ULONG) - input

Bank index to switch to.

Returns

rc (ULONG) - returns

Return codes indicating success or type of failure:

• DIVE_SUCCESS If the function succeeds, 0 is returned.
• DIVE_ERR_INVALID_INSTANCE The DIVE instance handle specified in the hDiveInst parameter is invalid.
• DIVE_ERR_BANK_SWITCH_FAILED The bank could not be switched to the specified parameters.
• DIVE_ERR_NO_DIRECT_ACCESS The display adapter, display driver, or current video mode does not support direct-to-screen access.

This function returns an error if any of the following conditions are met:

• Direct-screen access through the DIVE or EnDIVE dev_escapes are unavailable.
• The current hDiveInst has not issued DiveAcquireFrameBuffer.
• The frame buffer consists of a single aperture.

Remarks

Applications will not need to use this function if the frame buffer contains only a single aperture. The fMultipleAperture flag returned from DiveQueryCaps determines if this is necessary.

Example Code

#include <dive.h>

HDIVE hDiveInst;      /* Display engine DIVE instance. */
ULONG ulBankNumber;   /* Bank index to switch to. */
ULONG rc;             /* Return codes. */

rc = DiveSwitchBank(hDiveInst, ulBankNumber);

Related Methods

• DiveAcquireFrameBuffer
• DiveQueryCaps