Daten-Chunk eines PFP-File Version 3.
Mehr ...
In dieser Klasse werden die Daten eines einzelnen Chunks eines PFP-Files Version 3 gespeichert. Um einen Chunk zu erstellen, wird mit "new" eine neue Instanz der Klasse generiert und mit der Funktion PFPFile::AddChunk einem PFP-File hinzugefügt. Um einen existierenden Chunk zu löschen, kann einfach ein delete auf das Objekt gemacht werden, oder dir Funktion PFPFile::DeleteChunk aufgerufen werden.
- Siehe auch
- PFPFile
- Seit
- Diese Klasse wurde in Version 6.1.0 eingeführt
ppl6::PFPChunk::PFPChunk |
( |
| ) |
|
Der Konstruktor initialisiert den Datenbereich mit NULL und setzt als Name "UNKN" ein. Ein derartiger Chunk würde durch die PFPFile-Klasse nicht gespeichert.
- Seit
- Version 6.1.0
ppl6::PFPChunk::~PFPChunk |
( |
| ) |
|
Der Destruktor sorgt dafür, dass der Datenbereich des Chunks freigegeben wird, sofern er definiert wurde, und wenn er einem PFPFile zugeordnet wurde, wird er daraus entfernt.
- Seit
- Version 6.1.0
const void * ppl6::PFPChunk::Data |
( |
| ) |
|
Mit dieser Funktion wir der Pointer auf die Nutzdaten des Chunks ausgelesen.
- Rückgabe
- Enthält der Chunk Daten, wird ein Pointer darauf zurückgegeben. Wenn nicht, wird NULL zurückgegeben und der Fehlercode 424 gesetzt.
- Seit
- Version 6.1.0
const char * ppl6::PFPChunk::Name |
( |
| ) |
|
Diese Funktion liefert einen Pointer auf den Namen des Chunks zurück. Dieser ist immer 4 Byte groß und mit einem Nullbyte abgeschlossen.
- Rückgabe
- Pointer auf den Namen des Chunks.
- Seit
- Version 6.1.0
int ppl6::PFPChunk::SetData |
( |
const void * |
ptr, |
|
|
int |
size |
|
) |
| |
Mit dieser Funktion werden die Nutzdaten des Chunks angegeben. Die Daten werden dabei in einen eigenen Speicherbereich kopiert.
- Parameter
-
ptr | Ein Pointer auf den Beginn der Daten |
size | Größe der Daten in Byte |
- Rückgabe
- Bei Erfolg gibt die Funktion 1 zurück, im Fehlerfall 0. Ein entsprechender Fehlercode wird gesetzt. Ein Fehler könnte auftreten, wenn nicht mehr genug Speicher zur Verfügung steht, um die Daten zu kopieren.
- Seit
- Version 6.1.0
int ppl6::PFPChunk::SetData |
( |
const CString & |
s | ) |
|
Mit dieser Funktion werden die Nutzdaten des Chunks angegeben. Die Daten werden dabei in einen eigenen Speicherbereich kopiert.
- Parameter
-
s | Ein CString, dessen Inhalt als Nutzdaten übernommen werden soll. |
- Rückgabe
- Bei Erfolg gibt die Funktion 1 zurück, im Fehlerfall 0. Ein entsprechender Fehlercode wird gesetzt. Ein Fehler könnte auftreten, wenn nicht mehr genug Speicher zur Verfügung steht, um die Daten zu kopieren.
- Seit
- Version 6.1.0
int ppl6::PFPChunk::SetData |
( |
const char * |
s | ) |
|
Mit dieser Funktion werden die Nutzdaten des Chunks angegeben. Die Daten werden dabei in einen eigenen Speicherbereich kopiert.
- Parameter
-
s | Pointer auf einen 0-Terminierten String, der als Nutzdaten übernommen werden soll. |
- Rückgabe
- Bei Erfolg gibt die Funktion 1 zurück, im Fehlerfall 0. Ein entsprechender Fehlercode wird gesetzt. Ein Fehler könnte auftreten, wenn nicht mehr genug Speicher zur Verfügung steht, um die Daten zu kopieren.
- Seit
- Version 6.1.0
int ppl6::PFPChunk::SetName |
( |
const char * |
chunkname | ) |
|
- Beschreibung:
- Mit dieser Funktion wird der Name eines Chunks definiert. Der Name muss exakt 4 Byte lang sein und darf nur Großbuchstaben enthalten (es wird eine automatische Konvertierung durchgeführt).
- Parameter
-
chunkname | Pointer auf einen 0-Terminierten String, der den Namen des Chunks enthält. |
- Rückgabe
- Bei Erfolg gibt die Funktion 1 zurück, im Fehlerfall 0.
- Seit
- Version 6.1.0
int ppl6::PFPChunk::Size |
( |
| ) |
|
Mit dieser Funktion kann die Größe des Chunks ausgelesen werden.
- Rückgabe
- Enthält der Chunk Daten, wird die Anzahl Bytes zurückgegeben. Ist er leer, wird 0 zurückgegeben und der Fehlercode 424 gesetzt.
- Seit
- Version 6.1.0
char ppl6::PFPChunk::chunkname[5] |
|
private |
void* ppl6::PFPChunk::data |
|
private |
Die Dokumentation für diese Klasse wurde erzeugt aufgrund der Dateien:
- /jenkins/jobs/clang_ppl6/workspace/include/ppl6.h
- /jenkins/jobs/clang_ppl6/workspace/src/core/PFPFile.cpp