Daylight v4.9
Release Date: 1 February 2008


dt_welcome - retrieve a pipetalk welcome message

Generic Prototype

dt_welcome(dt_Handle) => dt_Handle

C Prototype

#include "dt_progob.h"

dt_Handle dt_welcome(dt_Handle program)

FORTRAN Prototype

include ''

integer*4 dt_f_welcome(program)

integer*4 program


Gets the program's welcome message, i.e., its response to being executed before being sent data. All child programs which follow the pipetalk protocol must write a welcome message (which may be empty), typically some sort of "banner" proclaiming their name and other startup information.

The welcome message is a newly-allocated sequence of string objects. Each string object contains one line of the program's welcome message. The sequence and strings returned by this function becomes "owned" by the function that calls this function; the sequence and its contents must eventually be deallocated via calls to dt_dealloc(3).

Return Value

Returns a sequence of strings. For objects other than programs, this message is defined as the NULL_OB.

Related Topics

dt_alloc_program(3) dt_converse(3) dt_delimiter(3) dt_setdelimiter(3)