Core Function ClearBit

Revision as of 08:59, 11 August 2014 (view source) UberFoX (Talk | contribs) (Created page with "<pre> ClearBit( <binary-array>, <index> ) </pre> === Description === Clear the bit at a given index. This will change the bit at the given index to FALSE. === Parameters === ...")

Revision as of 21:41, 11 August 2014 (view source) UberFoX (Talk | contribs) m (1 revision) Newer edit →

---

Revision as of 21:41, 11 August 2014

ClearBit( <binary-array>, <index> )

Contents 1 Description 2 Parameters 2.1 binary-array 2.2 index 3 Return Value 4 Remarks 5 Example

Description

Clear the bit at a given index.

This will change the bit at the given index to FALSE.

Parameters

binary-array

The binary variable to use.

index

Index of the bit to clear (This is not the index of the bytes).

Return Value

Success: Returns true if operation was a success (even if the Bit was already false)

Failure: Returns false

Remarks

See SetBit( ) for Remarks.

Example

See SetBit( ) for Example.