getBinaryStream Method (int)

Download JDBC driver

Retrieves the value of the designated column index in the current row of this SQLServerResultSet object as a binary stream of uninterpreted bytes.

Syntax

  
public java.io.InputStream getBinaryStream(int columnIndex)  

Parameters

columnIndex

An int that indicates the column index.

Return Value

An InputStream object.

Exceptions

SQLServerException

Remarks

This getBinaryStream method is specified by the getBinaryStream method in the java.sql.ResultSet interface.

This method can be used only with SQL Server data types of binary, varbinary, varbinary(max), and image. Trying to use it with other data types will cause an exception to be thrown.

After this method gets the value as a stream, the value can then be read in chunks from the stream. This method is particularly suitable for retrieving large LONGVARBINARY values.

Note

All the data in the returned stream must be read before getting the value of any other column. The next call to a getter method implicitly closes the stream. Also, a stream can return 0 when the method InputStream.available is called, whether there is data available or not.

See Also

getBinaryStream Method (SQLServerResultSet)
SQLServerResultSet Members
SQLServerResultSet Class