Back to Aurora Vision Library website

You are here: Start » Function Reference » All Functions » String » PadString

PadString


This is Filter Equivalent. This function may be present in generated code, but should not be used in hand-written code.

Header: STD.h
Namespace: avl
Module: FoundationLite

Extends a string if it is too short.

Syntax

void avl::PadString
(
	const atl::String& inString,
	const int inLength,
	const atl::String& inPadCharacter,
	const bool inPadAtBegin,
	atl::String& outString
)

Parameters

Name Type Range Default Description
Input value inString const String&
Input value inLength const int 0 - 8 Defines how many characters the output string will have if the input string is too short
Input value inPadCharacter const String& \" \" Characters inserted to pad the input string
Input value inPadAtBegin const bool Determines if pad characters will be inserted before first element
Output value outString String&

Errors

List of possible exceptions:

Error type Description
DomainError Pad string has to consist of one character in PadString.