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

FreeBSD Manual Pages

  
 
  

home | help
XmtVaRegisterSymbols(3)	   Library Functions Manual    XmtVaRegisterSymbols(3)

NAME
       XmtVaRegisterSymbols(),	XmtLookupSymbol() - register a name for	appli-
       cation variables, and lookup variables by name.

SYNOPSIS
       #include	<Xmt/Symbols.h>

       void XmtVaRegisterSymbols(String	name, String type, int size, XtPointer
		      address,
		      {	String name, String type, int size, XtPointer a
		      ddress, }
		      NULL)

       XmtSymbol XmtLookupSymbol(String	name)

ARGUMENTS
       INPUTS

	    name   The name of a symbol	to be registered, or  looked  up.  For
		   XmtVaRegisterSymbols()  this	argument may appear any	number
		   of times as part of a NULL terminated variable-length argu-
		   ment	list.

	    type   The representation type of the variable to  be  registered.
		   This	 argument  may appear any number of times as part of a
		   NULL-terminated variable-length argument list.

	    size   The size, in	bytes, of the variable to be registered.  This
		   argument may	appear any number of times as part of a	 NULL-
		   terminated variable-length argument list.

	    address
		   The address of the variable to be registered. This argument
		   may appear any number of times as part of a NULL-terminated
		   variable-length argument list.

       RETURNS

	    XmtLookupSymbol()  returns	the opaque XmtSymbol structure created
	    when the named symbol was registered.

DESCRIPTION
       XmtVaRegisterSymbols() lets you register	symbolic names for application
       variables. It takes  a  NULL-terminated	list  of  (name,  type,	 size,
       address)	 quadruples.  For each set of values, it registers name	as the
       symbolic	name for the variable at address with size size	and  represen-
       tation type type.

       Both  of	 the String arguments, name and	type must be constant strings,
       or at least permanently allocated strings-the symbol registration func-
       tion does not make copies of these strings, so they must	not be in mem-
       ory that	will be	freed, nor in  memory  on  the	stack.	Similarly,  of
       course,	you will want the address argument to be the address of	a sta-
       tic or global variable, or at least the address of memory that has been
       allocated and will never	be freed.

       XmtLookupSymbol() looks up an XmtSymbol structure for a	named  symbol.
       The  XmtSymbol  is an internal representation that is created when sym-
       bols are	registered. It can be  used  with  other  symbol  manipulation
       functions.

SEE ALSO
       Chapter 12, Symbols,
       XmtSymbolAddCallback(), XmtSymbolGetValue(), XmtSymbolRemoveCallback(),
       XmtSymbolSetValue().

Xmt				  Motif	Tools	       XmtVaRegisterSymbols(3)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=XmtVaRegisterSymbols&sektion=3&manpath=FreeBSD+Ports+15.0>

home | help