• Reference
• /
• Functions
• /
• string_head

string_head

Prototype:string_head(data, max)

Return type:string

Description: Returns the firstmax bytes ofdata.

Ifmax is negative, then everything but the lastmax 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:

bodycommoncontrol{bundlesequence=>{"example"};}bundleagentexample{vars:"start"string=>string_head("abc","1");# will contain "a"reports:"start of abc =$(start)";}

Output:

R: start of abc = a

History: Introduced in CFEngine 3.6

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

Still need help?

Chat

Ask a question on Github

Mailing list