LogText Function

Format

b = logtext(message ‖ message_numberʃ, argument1, ..., argumentNʅ);

Description

The logtext function writes a user-defined message to the paradata log.

The message is either a string expression or a numeric message number that contains the text that is written to the file. If the text contains any message formatters, the optional arguments argument1 to argumentN will be inserted into the text.

Return Value

The function returns a logical value of 1 (true) if successful and 0 (false) otherwise. If no paradata log file is open, then the function returns 0.

Example

PROC RELATIONSHIP

if RELATIONSHIP = 1 then
logtext("Head of household registered as %s",strip(NAME));
endif;