GetFormatStream Method for LCField

This method retrieves the format of a stream type field. It is only valid for fields of type text or binary.

Use the LCField.SetFormatStream method to assign stream format information. Refer to the Field Format section for a description of format values.

Defined In

LCField

Syntax

Call thisField.GetFormatStream (streamFlags, maxLength, streamFormat)

Parameters

All GetFormatStream parameters are outputs.


Value	Description
streamFlags	Long. Optional. Stream flags for the field. Refer in this chapter to "LCField Class Methods and Properties Summary," Stream Class section for a description of the flags.
maxLength	Long. Optional. Maximum length of the stream field. A value of zero indicates no maximum length.
streamFormat	Long. Optional. Stream format of the stream field. A value of zero indicates no specified stream format.

Example

Option Public
Uselsx "*lsxlc"  
Sub Initialize
  Dim field As New LCField (LCTYPE_BINARY)
  Dim fmt As Long
  Dim flags As Long
  Call field.SetFormatStream (LCSTREAMF_NO_CASE, 256, LCSTREAMFMT_BIG5)
  Call field.GetFormatStream (flags, , fmt)
  Print "The stream format and flag settings are:"
  Print "format=" & fmt & " flags=" & Hex(flags) & "h"
End Sub

Example Output

The stream format and flag settings are:
format=26 flags=10h