Prototype: string_head(data, max)

Return type: string

Description: Returns the first max bytes of data.

If max is negative, then everything but the last max bytes is returned.

Arguments:

  • data: string - Input string - in the range: .*
  • max: int - Maximum number of characters to return - in the range: -99999999999,99999999999

Example:

code
body common control
{
      bundlesequence => { "example" };
}

bundle agent example
{
  vars:
      "start" string => string_head("abc", "1"); # will contain "a"
  reports:
      "start of abc = $(start)";

}

Output:

code
R: start of abc = a

History: Introduced in CFEngine 3.6

See also: string_tail(), string_length(), string_reverse().