File: PetscFListGet.html

package info (click to toggle)
petsc 2.1.3-1.woody.1
  • links: PTS
  • area: main
  • in suites: woody
  • size: 70,272 kB
  • ctags: 310,869
  • sloc: ansic: 257,275; sh: 9,870; makefile: 7,622; fortran: 6,211; cpp: 1,026; python: 416; csh: 41; asm: 9
file content (41 lines) | stat: -rw-r--r-- 1,691 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML3.2 EN">
<HTML>
<HEAD>
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>PetscFListGet</TITLE>
</HEAD>
<BODY BGCOLOR="FFFFFF">
<A NAME="PetscFListGet"><H1>PetscFListGet</H1></A>
Gets an array the contains the entries in <A HREF="../Sys/PetscFList.html#PetscFList">PetscFList</A>, this is used by help etc. 
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
#include "petsc.h" 
int PetscFListGet(PetscFList list,char ***array,int *n)
</PRE>
Collective over MPI_Comm
<P>
<H3><FONT COLOR="#CC3333">Input Parameter</FONT></H3>
<DT><B>list   </B> -list of types
<br>
<P>
<H3><FONT COLOR="#CC3333">Output Parameter</FONT></H3>
<TABLE border="0" cellpadding="0" cellspacing="0">
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>array </B></TD><TD>- array of names
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>n </B></TD><TD>- length of array
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#CC3333">Notes</FONT></H3>
This allocates the array so that must be freed. BUT the individual entries are
not copied so should not be freed.
<P>

<P>
<H3><FONT COLOR="#CC3333">See Also</FONT></H3>
 <A HREF="../Sys/PetscFListAddDynamic.html#PetscFListAddDynamic">PetscFListAddDynamic</A>(), <A HREF="../Sys/PetscFList.html#PetscFList">PetscFList</A>
<BR><P><B><P><B><FONT COLOR="#CC3333">Level:</FONT></B>developer
<BR><FONT COLOR="#CC3333">Location:</FONT></B><A HREF="../../../src/sys/src/dll/reg.c.html#PetscFListGet">src/sys/src/dll/reg.c</A>
<BR><A HREF="./index.html">Index of all Sys routines</A>
<BR><A HREF="../../index.html">Table of Contents for all manual pages</A>
<BR><A HREF="../singleindex.html">Index of all manual pages</A>
</BODY></HTML>