xMBUtilSetBits() function

Function to set bits in a byte buffer. This function allows the efficient use of an array to implement bitfields. The array used for storing the bits must always be a multiple of two bytes. Up to eight bits can be set or cleared in one operation.

 ucBits[2] = {0, 0};
 // Set bit 4 to 1 (read: set 1 bit starting at bit offset 4 to value 1)
 xMBUtilSetBits( ucBits, 4, 1, 1 );
 // Set bit 7 to 1 and bit 8 to 0.
 xMBUtilSetBits( ucBits, 7, 2, 0x01 );
 // Set bits 8 - 11 to 0x05 and bits 12 - 15 to 0x0A;
 xMBUtilSetBits( ucBits, 8, 8, 0x5A);
 

Syntax

Show:

Summary

Declaration

Definition

from mbutils.h:85

void xMBUtilSetBits( UCHAR * ucByteBuf, USHORT usBitOffset, UCHAR ucNBits, UCHAR ucValues );

Implemented in mbutils.c:53

Arguments

Argument

Description

ucByteBuf

A buffer where the bit values are stored. Must be a multiple of 2 bytes. No length checking is performed and if usBitOffset / 8 is greater than the size of the buffer memory contents is overwritten.

usBitOffset

The starting address of the bits to set. The first bit has the offset 0.

ucNBits

Number of bits to modify. The value must always be smaller than 8.

ucValues

Thew new values for the bits. The value for the first bit starting at usBitOffset is the LSB of the value ucValues

ucValue

Examples

References

from examples

xMBUtilSetBits() function

Syntax

Arguments

Examples

References

Call Tree

Data Use

Class Tree

Override Tree

Implementations

Instances

Lifecycle