SPI_connect
SPI_connect — connect a procedure to the SPI manager
Synopsis
int SPI_connect(void)
Description
SPI_connect
opens a connection from a procedure invocation to the SPI manager. You must call this function if you want to execute commands through SPI. Some utility SPI functions can be called from unconnected procedures.
If your procedure is already connected,SPI_connect
will return the error codeSPI_ERROR_CONNECT. This could happen if a procedure that has calledSPI_connect
directly calls another procedure that callsSPI_connect
. While recursive calls to theSPI manager are permitted when an SQL command called through SPI invokes another function that usesSPI, directly nested calls toSPI_connect
andSPI_finish
are forbidden. (But seeSPI_push
andSPI_pop
.)
Return Value
SPI_OK_CONNECT
on success
SPI_ERROR_CONNECT
on error