IBX.IBStoredProc.TIBStoredProc.Prepared

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

property Prepared: Boolean read FPrepared write SetPrepare;

C++

__property bool Prepared = {read=FPrepared, write=SetPrepare, nodefault};

Properties

Type Visibility Source Unit Parent
property public
IBX.IBStoredProc.pas
IBX.IBStoredProc.hpp
IBX.IBStoredProc TIBStoredProc

Description

Determines whether or not a stored procedure is prepared for execution.

Examine Prepared to determine if a stored procedure is already prepared for execution. If Prepared is true, the stored procedure is prepared, and if Prepared is false, the procedure is not prepared. A stored procedure must be prepared before it can be executed.

Note: A stored procedure is automatically prepared if it is unprepared when the application calls ExecProc. After execution, the stored procedure is then automatically unprepared. If a procedure will be executed a number of times, it is more efficient for the application to prepare the stored procedure once, and unprepare it when it is no longer needed.

An application can change the current setting of Prepared to prepare or unprepare a stored procedure. If Prepared is true, setting it to false calls the UnPrepare method to unprepare the stored procedure. If Prepared is false, setting it to true calls the Prepare method to prepare the procedure. Generally, however, it is better programming practice to call Prepare and UnPrepare directly. These methods automatically update the Prepared property.