lengthIsMax

Short summary

This assertion method checks if the current string stringToCheck is length is equal or less than to maxLength

Attention: All strings are handled as null terminated byte/word streams. For UTF-8 is end of the string 16#00 For UTF-16 is end of the string 16#00_00

Attention: The interface IUnicodeAssertions uses ANY_STRING, for this it's not possible to use literals/constants, because for ANY types generates the compiler __SYSTEM.AnyType and __SYSTEM.AnyType contains a pointer

Parameters

Name	Type	Comment	Kind
stringToCheck	ANY_STRING	current string to check	input
maxLength	UDINT	upper limit of the length of stringToCheck	input
stringLengthUnit	UnicodeStringLengthUnit	string length units of measurement	input
message	AssertMessage	message if the assertion is false	input

Code

Declaration

METHOD lengthIsMax
VAR_INPUT
	(* current string to check *)
	stringToCheck	:ANY_STRING;
	(* upper limit of the length of ``stringToCheck`` *)
	maxLength		:UDINT;
	(* string length units of measurement *)
	stringLengthUnit	:UnicodeStringLengthUnit;
	(* message if the assertion is false *)
	message			:AssertMessage;
END_VAR

Implementation

CASE stringToCheck.TypeClass OF
TYPE_CLASS.TYPE_STRING:
	THIS^.utf8Assertions.lengthIsMax(
		stringToCheck	:= stringToCheck.pValue,
		maxLength		:= maxLength,
		stringLengthUnit := stringLengthUnit,
		message			:= message
	);
TYPE_CLASS.TYPE_WSTRING:
	THIS^.utf16Assertions.lengthIsMax(
		stringToCheck	:= stringToCheck.pValue,
		maxLength		:= maxLength,
		stringLengthUnit := stringLengthUnit,
		message			:= message
	);
ELSE
	; // do nothing
END_CASE