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
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML3.2 EN">
<HTML>
<HEAD> <link rel="canonical" href="http://www.mcs.anl.gov/petsc/petsc-current/docs/manualpages/Sys/PetscObjectListRemoveReference.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>PetscObjectListRemoveReference</TITLE>
</HEAD>
<BODY BGCOLOR="FFFFFF">
<div id="version" align=right><b>petsc-3.7.5 2017-01-01</b></div>
<div id="bugreport" align=right><a href="mailto:petsc-maint@mcs.anl.gov?subject=Typo or Error in Documentation &body=Please describe the typo or error in the documentation: petsc-3.7.5 v3.7.5 docs/manualpages/Sys/PetscObjectListRemoveReference.html "><small>Report Typos and Errors</small></a></div>
<A NAME="PetscObjectListRemoveReference"><H1>PetscObjectListRemoveReference</H1></A>
Calls <A HREF="../Sys/PetscObjectDereference.html#PetscObjectDereference">PetscObjectDereference</A>() on an object in the list immediately but keeps a pointer to the object in the list.
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
PetscErrorCode PetscObjectListRemoveReference(PetscObjectList *fl,const char name[])
</PRE>
<H3><FONT COLOR="#CC3333">Input Parameters</FONT></H3>
<TABLE border="0" cellpadding="0" cellspacing="0">
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>fl </B></TD><TD>- the object list
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>name </B></TD><TD>- the name to use for the object
</TD></TR></TABLE>
<P>
<P>
Notes: Use <A HREF="../Sys/PetscObjectListAdd.html#PetscObjectListAdd">PetscObjectListAdd</A>(<A HREF="../Sys/PetscObjectList.html#PetscObjectList">PetscObjectList</A>,const char name[],NULL) to truly remove the object from the list
<P>
Use this routine ONLY if you know that the object referenced will remain in existence until the pointing object is destroyed
<P>
Developer Note: this is to handle some cases that otherwise would result in having circular references so reference counts never got to zero
<P>
<H3><FONT COLOR="#CC3333">See Also</FONT></H3>
<A HREF="../Sys/PetscObjectListDestroy.html#PetscObjectListDestroy">PetscObjectListDestroy</A>(), <A HREF="../Sys/PetscObjectListFind.html#PetscObjectListFind">PetscObjectListFind</A>(), <A HREF="../Sys/PetscObjectListDuplicate.html#PetscObjectListDuplicate">PetscObjectListDuplicate</A>(), <A HREF="../Sys/PetscObjectListReverseFind.html#PetscObjectListReverseFind">PetscObjectListReverseFind</A>(), <A HREF="../Sys/PetscObjectListDuplicate.html#PetscObjectListDuplicate">PetscObjectListDuplicate</A>(), <A HREF="../Sys/PetscObjectListAdd.html#PetscObjectListAdd">PetscObjectListAdd</A>()
<BR>
<P>
<P><B><P><B><FONT COLOR="#CC3333">Level:</FONT></B>developer
<BR><FONT COLOR="#CC3333">Location:</FONT></B><A HREF="../../../src/sys/objects/olist.c.html#PetscObjectListRemoveReference">src/sys/objects/olist.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>
|
