GenerateFileName

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

Generates consecutive file names, eg. for saving series of images

Syntax

void avl::GenerateFileName
(
	GenerateFileNameState& ioState,
	const atl::Directory& inDirectory,
	const atl::String& inPattern,
	atl::File& outFile
)

Parameters

Name	Type	Default	Description
ioState	GenerateFileNameState&		Object used to maintain state of the function.
inDirectory	const Directory&	\".\"	Input directory
inPattern	const String&	\"file_$_####.txt\"	File name pattern, $ is replaced by date, # is replaced by number
outFile	File&		Generated file name

Errors

Error type	Description
DomainError	Given directory does not exist in GenerateFileName.
DomainError	Exactly one series of # characters is required in pattern in GenerateFileName.