opendarwin man page for getphfig

GETPHFIG(3)						  MBK PHYSICAL UTILITY FUNCTIONS					       GETPHFIG(3)

NAME

       getphfig - give back a pointer to a phfig

ORIGIN

       This  software  belongs	to  the  ALLIANCE CAD SYSTEM developed by the ASIM team at LIP6 laboratory of Universite Pierre et Marie CURIE, in
       Paris, France.

       Web : http://asim.lip6.fr/recherche/alliance/
       E-mail : alliance-users@asim.lip6.fr

SYNOPSYS

       #include "mph.h"
       phfig_list *getphfig(figname, mode)
       char *figname;
       char mode;

PARAMETERS

       figname		   Name of the figure to be created mode Demanded mode for the figure

DESCRIPTION

       getphfig returns a pointer to the figure called figname with the warranty that the expected information is present in memory.
       If mode is 'A' then the figure has all its lists filled, else the figure may either be complete or interface only.
       This function allows to completly mask disk access for applications programs. If the figure is in memory, with the specified mode, then the
       function  returns  the appropriate pointer. Else, the function performs a call to the loadphfig(3) and returns a pointer to the loaded fig-
       ure.

RETURN VALUE

       getphfig returns a pointer to the wanted figure.

ERRORS

       getphfig cannot give any errors, but the subsequent calls it performs to parsers do. So the source of trouble may be the call to  getphfig.
       See loadphfig(3) for details.

EXAMPLE

       #include "mph.h"
       phfig_list *na2_y()
       {
	  /* find in memory or load from disk na2_y */
	  return getphfig("na2_y", 'A');
       }

SEE ALSO

       mbk(1), phfig(3), addphfig(3), delphfig(3), loadphfig(3), savephfig(3), flattenphfig(3), rflattenphfig(3).

BUG REPORT

       This tool is under development at the ASIM department of the LIP6 laboratory.
       We need your feedback to improve documentation and tools.

ASIM
/LIP6							  October 1, 1997						       GETPHFIG(3)