Skip to content

Plsqlap_Buffer_API Overview

The package Plsqlap_Buffer_API is used to handle buffers and context parameters. The package contains methods to create and manipulate buffers and PLSQL subtypes used to declare the method parameters. The package also contains methods to create and retrieve context parameters.

NOTE: This package is private and must only be used internally by the Plsql Access Provider.

Data Types and Constants

Type List Subtype  list

Methods

Procedure Add_Blob_Item Add a simple item to a buffer.
Procedure Add_Clob_Item Add a simple item to a buffer.
Procedure Add_Compound_Item Add a compound item (buffer) to a buffer.
Procedure Add_Item Add a simple item to a buffer.
Procedure Clear_Buffer Removes a buffer and releases the memory occupied by the buffer.
Function Count_Items Returns the number of items in a buffer.
Procedure Debug Prints a buffer.
Function Get_Blob_Value Returns the value of an item as BLOB.
Function Get_Buffer Returns a buffer from a compound item.
Function Get_Clob_Value Returns the value of an item as CLOB.
Function Get_Context_Parameter Returns a named context parameter value.
Function Get_Item_By_Name Returns a named item from a buffer.
Function Get_Item_By_Position Returns the item at a given position in a buffer.
Function Get_Item_Position Returns the position of a named item in a buffer.
Function Get_Name Returns the name of an item.
Function Get_Status Returns the status of an item.
Function Get_Type Returns the type of an item.
Function Get_Type_Name Returns the name of a type.
Function Get_Value Returns the value of an item.
Function Is_Compound Returns TRUE if an item is a compound item otherwise returns FALSE.
Function New_Buffer Create a new buffer.
Procedure Remove_Context_Parameter Remove a context parameter.
Procedure Set_Blob_Item Sets or changes the attributes of a simple item in a buffer.
Procedure Set_Blob_Item_Value Sets or changes the value of a simple item in a buffer.
Procedure Set_Clob_Item Sets or changes the attributes of a simple item in a buffer.
Procedure Set_Clob_Item_Value Sets or changes the value of a simple item in a buffer.
Procedure Set_Context_Parameter Sets a named context parameter value.
Procedure Set_Item Sets or changes the attributes of a simple item in a buffer.
Procedure Set_Item_Status Sets or changes the status of a simple item in a buffer.
Procedure Set_Item_Typ Sets or changes the type of a simple item in a buffer.
Procedure Set_Item_Value Sets or changes the value of a simple item in a buffer.
Function To_Xml Convert buffer to VARCHAR2 containing an XML document.
Procedure To_Xml Convert buffer to CLOB containing an XML document.