Bei diesem Parameter handelt es sich um Bitfeld, bei dem jedes Bit einzeln interpretiert wird. Der Parameter muss vom Typ INT32, INT64, FLOAT oder STRING sein. Weitere Details zu Bitfeld-Parametern sind unter »Bit-Manipulationen« beschrieben.

options

Flags (Typ INT32), die die Darstellung des Bitfeldes beeinflussen. Ohne Angabe wird _BF_RANGES vewendet.

name_list

Eine Liste mit Namen. Anstatt einer Zahl wird der Name mit dem entsprechenden Index ausgegeben, falls der Name vorhanden ist und mindestens ein Zeichen hat.

Zeichenketten werden automatisch in eine Liste gewandelt, wobei das Komma als Trennzeichen genitzt wird.

Beschreibung:

Anmerkung: Diese Funktion hieß formals bitmap() bzw. bitfield().

printBitField() wandelt das Ergebnis des Ausdruckes x in eine Zeichenkette in Bitmapdarstellung im Format '<...>' um.

Der Parmeter options:

Die folgenden Konstanten legen Optionen bei der textuellen Ausgabe der Bitfelder fest. Jede Konstante repräsentiert exakt ein Bit. Alle Konstanten können mittels OR miteinander kombiniert werden.

_BF_REVERSE_ENDIAN
Diese Option gibt an, dass die Daten in für das lokale System falschen Endian vorliegen.
Das Flag _BF_REVERSE_ENDIAN ist nur relevant, wenn mindestens eines der Flags _BF_2BYTES, _BF_4BYTES oder _BF_8BYTES angegeben wurde.
_BF_RANGES
Normalerweise wird eine kommaseparierte Liste mit den Bitnummern der gesetzten Bits ausgegeben. Ist _BF_RANGES gesetzt, dann werden Bitfolgen von 3 oder mehr gesetzten Bits in der Form 'a:b' ausgegeben.
_BF_BRACKETS
Ist _BF_BRACKETS und ist mindestens ein Bit des auszugebenen Wertes gesetzt, dann wird die Ausgabe in spitzen Klammern '<...>' eingeschlossen.
_BF_FORCE_BRACKETS
Ist _BF_FORCE_BRACKETS gesetzt, dann wird die Ausgabe in spitzen Klammern '<...>' eingeschlossen. Dieses gilt im Gegensatz zu _BF_BRACKETS auch, wenn kein Bit des auszugebenen Wertes gesetzt ist.
_BF_CHARSET
Bits aus dem ASCII-Bereich 0x20 bis einschließlich 0x7e werden speziell behandelt. Ist mindestens ein Bit hieraus gesetzt, dann wird das Format '[...]<...>' für die Ausgabe verwendet.
In den eckigen Klammern ([]) werden die Bits aus dem genannten Bereich gesetzt, wobei Bereiche der Form a-f verwendet werden. Dabei wird darauf geachtet, dass ']' nur als erstes Zeichen und '-' nur als letztes Zeichen eingesetzt wird.
Ist kein Bit gesetzt, dann wird nicht ausgegeben, da bei '[]' die schließende Klammer als Einzelzeichen und nicht ale Ende des Bereiches erkannt würde.
Sind noch andere Bits außerhalb des genannten Bereiches gesetzt, dann erfolgt eine normale Ausgabe dieser restlichen Bits.
_BF_ONLY_CHARSET
Dieses Flag aktiviert _BF_CHARSET und unterdrückt die Ausgabe der Bits, die nicht durch _BF_CHARSET erfasst werden. Das Ausgabeformat ist daher '[...]' oder die leere Zeichenkette, wenn kein durch _BF_CHARSET erfasstes Bit gesetzt ist.
_BF_2BYTES
Dieses ist ein Hinweis insbesondere für big endian-Zahlen: Die angegeben Daten sind Ganzzahlen mit jeweils 2 Bytes. Dieses hat Einfluss auf die Bitnummern. Die Datenlänge des Bereiches wird auf das größte Vielfache von 2, welches kleiner oder gleich der angegebenen Länge ist, begrenzt.
_BF_4BYTES
Dieses ist ein Hinweis insbesondere für big endian-Rechner: Die angegeben Daten sind Ganzzahlen mit jeweils 4 Bytes. Dieses hat Einfluss auf die Bitnummern. Die Datenlänge des Bereiches wird auf das größte Vielfache von 4, welches kleiner oder gleich der angegebenen Länge ist, begrenzt.
_BF_4BYTES hat Vorrang vor _BF_2BYTES.
_BF_8BYTES
Dieses ist ein Hinweis insbesondere für big endian-Rechner: Die angegeben Daten sind Ganzzahlen mit jeweils 8 Bytes. Dieses hat Einfluss auf die Bitnummern. Die Datenlänge des Bereiches wird auf das größte Vielfache von 8, welches kleiner oder gleich der angegebenen Länge ist, begrenzt.
_BF_8BYTES hat Vorrang vor _BF_2BYTES und _BF_4BYTES.

Funktionsergebnis: NONE/STRING

In Abhängigkeit des Types eines Wertes erfolgt die folgende Wandlung:

NONE, LIST, MAP
Es wird der Wert NONE mit gesetzten Fehlerkode als Funktionsergebnis geliefert.
INT32
Die Zahl wird in die Bitfelddarstellung '<...>' gewandelt. Innerhalb der spitzen Klammern wird eine durch Kommata getrennte Liste erzeugt. Für jedes gesetzte Bit wird ein Eintrag mit der Nummer in die Liste vorgenommen.
Sollten support_colon==true sein und drei oder mehr Bits hintereinander gesetzt sein, so wird ein Eintrag der Form 'a:b' erzeugt, wobei 'a' der Bitmummer des niedrigstwertigsten Bits und b der Bitnummer des höchstwerigen gesetzen Bits entspricht.
Beispiel: Die Zahl 39 == 32 + 4 + 2 + 1 wird in die Zeichenkette '0:2,5' gewandelt.
INT64
Die Zahl wird in die Bitfelddarstellung '<...>q' gewandelt. Die Umwandlung der 64 Bits erfolgt genauso wie bei den 32-Bit Zahlen.
FLOAT
Die Zahl wird in die Bitfelddarstellung '< ... >q' gewandelt. Bei der Umwandlung wird der Wert (die unveränderte Bitdarstellung) als 64-Bit Ganzzahl betrachtet und entsprechend gewandelt.
STRING
Die Zeichenkette wird als Bitfeld betrachtet. Die Umsetzung der formatierten Ausgabe erfolgt genauso wie bei den 32-Bit Zahlen.

Siehe auch:
Bit-Manipulationen scanBitField()

Weitere ähnliche Funktionen:

Bit-Manipulation
Funktion	Kurzinfo
bitField2list()	Aus einem Bitfeld eine numerische Liste erzeugen.
clearBit()	Ein Bit löschen.
clearBits()	Mehrere aufeinanderfolgende Bits in einem Bitfeld löschen.
count0bits()	Anzahl der 0-Bits zählen.
count1bits()	Anzahl der 1-Bits zählen.
highest0bit()	Das höchstwertigste 0-Bit suchen.
highest1bit()	Das höchstwertigste 1-Bit suchen.
invertBit()	Ein Bit invertieren.
invertBits()	Mehrere aufeinanderfolgende Bits in einem Bitfeld invertieren.
l$bitField()	Aus den numerischen Elementen einer Liste wird ein Bitfeld erzeugt.
lowest0bit()	Das niederwertigste 0-Bit suchen.
lowest1bit()	Das niederwertigste 1-Bit suchen.
normBits()	—
printBitField()	Ein Bitfeld in eine textuelle Darstellung überführen.
scanBitField()	—
setBit()	Ein Bit setzen.
setBits()	Mehrere aufeinanderfolgende Bits in einem Bitfeld setzen.
shiftBits()	—
testBit()	—

Formatierte Ausgabe
Funktion	Kurzinfo
hexDump()	Eine Zeichenkette als Hex-Dump ausgeben.
Print()	Einen formatierten Text erzeugen.
printBitField()	Ein Bitfeld in eine textuelle Darstellung überführen.
printFileName()	—
printInterval()	textausgabe eines Zeitintervalles
printRoman()	Ganzzahl in römischer Schreibweise ausgeben.
printTime()	Formatierte Ausgabe einer Datums- und Zeitangabe.
string()	—