mirrors
/
postgres
mirror of https://github.com/postgres/postgres
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Improve comments for SearchSysCacheTuple and SearchSysCacheTupleCopy.

This commit is contained in:
Tom Lane 2000-06-06 17:02:38 +00:00
parent 05cd91a582
commit e57e991e80
1 changed files with 10 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
src/backend/utils/cache/syscache.c vendored
View File

@ -8,7 +8,7 @@
* *
* *
* IDENTIFICATION * IDENTIFICATION
* $Header: /cvsroot/pgsql/src/backend/utils/cache/syscache.c,v 1.50 2000/04/12 17:15:54 momjian Exp $ * $Header: /cvsroot/pgsql/src/backend/utils/cache/syscache.c,v 1.51 2000/06/06 17:02:38 tgl Exp $
* *
* NOTES * NOTES
* These routines allow the parser/planner/executor to perform * These routines allow the parser/planner/executor to perform
@ -456,8 +456,10 @@ InitCatalogCache()
/* /*
* SearchSysCacheTupleCopy * SearchSysCacheTupleCopy
* *
* This is like SearchSysCacheTuple, except it returns a copy of the tuple * This is like SearchSysCacheTuple, except it returns a palloc'd copy of
* that the user is required to pfree(). * the tuple. The caller should heap_freetuple() the returned copy when
* done with it. This routine should be used when the caller intends to
* continue to access the tuple for more than a very short period of time.
*/ */
HeapTuple HeapTuple
SearchSysCacheTupleCopy(int cacheId, /* cache selection code */ SearchSysCacheTupleCopy(int cacheId, /* cache selection code */
@ -485,7 +487,11 @@ SearchSysCacheTupleCopy(int cacheId, /* cache selection code */
* Returns the cache copy of the tuple if one is found, NULL if not. * Returns the cache copy of the tuple if one is found, NULL if not.
* The tuple is the 'cache' copy. * The tuple is the 'cache' copy.
* *
* XXX The tuple that is returned is NOT supposed to be pfree'd! * CAUTION: The tuple that is returned must NOT be freed by the caller!
*
* CAUTION: The returned tuple may be flushed from the cache during
* subsequent cache lookup operations, or by shared cache invalidation.
* Callers should not expect the pointer to remain valid for long.
*/ */
HeapTuple HeapTuple
SearchSysCacheTuple(int cacheId,/* cache selection code */ SearchSysCacheTuple(int cacheId,/* cache selection code */