PChar

This is an old revision of PChar, edited by Kai Burghardt at . The current revision is 116305.

/* caveats */ move accidentally misplaced note, supposedly add new external links [spam detection false positive]

Template:Pchar

The data type pChar is a pointer to a single char.

type
    pChar = ^char;

PAnsiChar is an alias for pChar.

special support

A pChar could be interpreted as a pointer to NULL-terminated string data type value on the heap. This means this string value ends with chr(0). This kind of storing data is rather unsafe and Pascal’s own string data types always indicate an explicit (maximum) length. However, many libraries written in other programming languages make use of this dangerous data type and in order to facilitate interaction with them the FPC provides special support (only available in non-ISO modes).

direct assignments

A string literal can be assigned directly to a pChar:

program pCharDemo(output);
var
    p: pChar;
begin
    p := 'Foobar';
    writeLn(p);
end.

This assigns p the address of an invisible constant value. That means you are not allowed to alter any component of this value. (Enforced since FPC 3.0.0)

routines

Write/writeLn can accept a pChar and take it as a null-terminated string (provided the destination is a text file). Conversely writeStr does not support pChar.

The standard run-time library provides many handy functions:

There is also {$modeSwitch pCharToString}/‑MpCharToString automatically interpreting pChar values as null-terminated strings and automatically converting them to the destination’s string data type.

data types

The ANSIString data type is a pointer to a char and always ends with a complimentary null-Byte which allows direct typecasting to pChar:

program ansiStringAsPcharDemo(output);
var
    s: ANSIString;
    p: pChar;
begin
    s := 'foobar';
    p := pChar(s);
    writeLn(p);
end.

Beware that this works well only as long as you are merely reading from the typecasted value. Also note that an ANSIString is allowed to contain chr(0) as payload.

If you intend to alter data via the pointer, you possibly want to call uniqueString before you do the typecast.

caveats

The pChar data type used as a null-terminated string data type is rather an anomaly in the Pascal world. It has many caveats:

Using a pChar just as a regular pointer to a single char, however, does not have any special caveats.

see also