void |
registerOutParameter( |
[in] long |
parameterIndex, |
| [in] long |
sqlType, |
| [in] string |
typeName ) |
raises( |
SQLException ); |
- Description
- registers the designated output parameter. This version of
the method
XOutParameters::registerOutParameter()
should be used for a user-named or REF output parameter. Examples
of user-named types include: STRUCT, DISTINCT, OBJECT, and named array
types.
Before executing a stored procedure call, you must explicitly
call
XOutParameters::registerOutParameter()
to register the type from
DataType
for each OUT parameter.
For a user-named parameter the fully-qualified SQL type name of the
parameter should also be given, while a REF parameter requires that the
fully-qualified type name of the referenced type be given.
An SDBC driver that does not need the type code and type name information
may ignore it. To be portable, however, applications should always provide
these values for user-named and REF parameters.
Although it is intended for user-named and REF parameters,
this method may be used to register a parameter of any SDBC type.
If the parameter does not have a user-named or REF type, the
typeName parameter is ignored.
Note: When reading the value of an out parameter, you
must use the
getXXX
method whose type XXX corresponds to the
parameter's registered SQL type.
- Parameter parameterIndex
- the first parameter is 1, the second is 2, ...
- Parameter sqlType
- the type of the column to register
- Parameter typeName
- the name of the type
- Throws
- SQLException
if a database access error occurs.
|