Constref

Version 2.6 of Free Pascal added the constref parameter qualifier.

program call_method;

var x : longint ;

procedure test_cr(constref cr: longint);
begin
  writeln('Parameter 5 has been passed by reference: ', cr );
end;

begin
  test_cr(5);
  x:=6;
  test_cr(x);
end.

It is like the const parameter qualifier. This qualifier informs the compiler that within the entire program there is no code that will change the value of the parameter while the procedure/function is executing.

This means that not only the parameter, but also the variable (in above example: x) passed by the caller (e.g. a global var) must not be changed until the call with the constref parameter has returned.

In addition to being like const parameter qualifier, the constref qualifier enforces that the parameter is passed by reference.

This differs from the const parameters, which may be passed as reference or value depending on what the compiler thinks is best.

The new feature notes for version 2.6 suggest that this can be used for interfacing with external routines in other languages, where this type of parameter passing is required. Other uses of constref may hinder the compiler from optimizing code.

See also

• const
• var

From the Free Pascal wiki, page "Constref", as it stood on 2019-05-04 after a change by Jonas, out of the wiki's dump of 2024-05-26. Copyright stays with the author who wrote it, according to the old wiki's Licensing page. If you have concerns about this material, message the admin.