GetString Method

 

Description

 

Returns the Recordset as a string.

 

PowerBASIC Syntax

 

METHOD GetString ( _

  OPTIONAL BYVAL StringFormat AS LONG, _

  OPTIONAL BYVAL NumRows AS LONG, _

  OPTIONAL BYVAL ColumnDelimeter AS WSTRING, _

  OPTIONAL BYVAL RowDelimeter AS WSTRING, _

  OPTIONAL BYVAL NullExpr AS WSTRING _

) AS WSTRING

 

Parameters

 

StringFormat

Optional. A StringFormatEnum value that specifies how the Recordset should be converted to a string. The RowDelimiter, ColumnDelimiter, and NullExpr parameters are used only with a StringFormat of adClipString.

NumRows

Optional. The number of rows to be converted in the Recordset. If NumRows is not specified, or if it is greater than the total number of rows in the Recordset, then all the rows in the Recordset are converted.

ColumnDelimiter

Optional. A delimiter used between columns, if specified, otherwise the TAB character.

RowDelimiter

Optional. A delimiter used between rows, if specified, otherwise the CARRIAGE RETURN character.

NullExpr

Optional. An expression used in place of a null value, if specified, otherwise the empty string.

 

Return Value

 

STRING. The Recordset as a string-valued Variant (BSTR).

 

Remarks

 

Row data, but no schema data, is saved to the string. Therefore, a Recordset cannot be reopened using this string.

 

This method is equivalent to the RDO GetClipString method.

 

Valid XHTML 1.0 Transitional