Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
Instantiate(special file)			     Instantiate(special file)

NAME
       Instantiate -- open a document factory

SYNOPSIS
       [file] Instantiate(in mediaType template);

DESCRIPTION
       The  Instantiate	request	causes the handler to open a factory for medi-
       aType documents based on	template. Usually this means opening an	 unti-
       tled  buffer not	bound to any file.  The	handler	replies	when the unti-
       tled buffer is successfully opened.

       The template argument is	the template of	the document.  If  this	 argu-
       ment is unset (in other words, has a value of (char *)0), then the tem-
       plate to	us is in the file named	in the message's  file	attribute.  If
       the  file  attribute  is	also unset, no template	has been supplied, and
       the factory should use its default template (usually, an	empty buffer).
       The  data  type	(mediaType) of the template argument should be string,
       unless nulls are	valid in the given media type, in which	case the  data
       type must be bytes.

APPLICATION USAGE
       The  ttmedia_ptype_declare(3) function can be used to register for, and
       help process, this message.

       This message can	be sent	with the ttmedia_load(3) function.

EXAMPLES
       To instantiate an appointment document, the application can send	an In-
       stantiate request with a	first argument whose vtype is DT_APPOINTMENT.

ERRORS
       The ToolTalk service may	return one of the following errors in process-
       ing the Instantiate request:

       TT_DESKTOP_ENOENT
		 The file that was alleged to contain the  template  does  not
		 exist.

       TT_MEDIA_ERR_FORMAT
		 The template is not a valid instance of the media type.

SEE ALSO
       ttmedia_ptype_declare(3), ttmedia_load(3); Intro, Deposit, Edit,	Status
       requests.

						     Instantiate(special file)

NAME | SYNOPSIS | DESCRIPTION | APPLICATION USAGE | EXAMPLES | ERRORS | SEE ALSO

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=Instantiate&sektion=4&manpath=FreeBSD+12.1-RELEASE+and+Ports>

home | help