Back to Aurora Vision Library Lite website
You are here: Start » 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 |
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 | |
---|---|---|---|---|---|
inString | const String& | ||||
inLength | const int | 0 - | 8 | Defines how many characters the output string will have if the input string is too short | |
inPadCharacter | const String& | \" \" | Characters inserted to pad the input string | ||
inPadAtBegin | const bool | Determines if pad characters will be inserted before first element | |||
outString | String& |
Errors
List of possible exceptions:
Error type | Description |
---|---|
DomainError | Pad string has to consist of one character in PadString. |