diff options
Diffstat (limited to 'doc/src')
| -rw-r--r-- | doc/src/sgml/spi.sgml | 13 |
1 files changed, 13 insertions, 0 deletions
diff --git a/doc/src/sgml/spi.sgml b/doc/src/sgml/spi.sgml index 55ca90ad58f..493c74b4e5d 100644 --- a/doc/src/sgml/spi.sgml +++ b/doc/src/sgml/spi.sgml @@ -2092,6 +2092,19 @@ Portal SPI_cursor_find(const char * <parameter>name</parameter>) <symbol>NULL</symbol> if none was found </para> </refsect1> + + <refsect1> + <title>Notes</title> + + <para> + Beware that this function can return a <type>Portal</type> object + that does not have cursor-like properties; for example it might not + return tuples. If you simply pass the <type>Portal</type> pointer + to other SPI functions, they can defend themselves against such + cases, but caution is appropriate when directly inspecting + the <type>Portal</type>. + </para> + </refsect1> </refentry> <!-- *********************************************** --> |