AddOptionalStringItem Method

[VB6]

Sub AddOptionalStringItem(Name As String)

[Delphi 7]

procedure AddOptionalStringItem(const Name: WideString);

Description

The AddOptionalStringItem method adds a new parameter to the ParameterCollection that holds a string value.  The new parameter is added as an optional parameter, which means that its value does not need to be set.  Once it has been added, it's value can be set with the StringItem property.  If the parameter name specified as the argument to this method already exists in the collection, an error will occur.

Example

[VB6]

Sub ParameterCollection_AddOptionalStringItem()

    Dim pc As New ParameterCollection

    pc.AddOptionalAngularItem "an_optional_angular_item"

    pc.AddOptionalFloatItem "an_optional_float_item"

    pc.AddOptionalIntegerItem "an_optional_integer_item"

    pc.AddOptionalLinearItem "an_optional_linear_item"

    pc.AddOptionalStringItem "an_optional_string_item"

End Sub

[Delphi 7]

procedure ParameterCollection_AddOptionalStringItem();

var

  pc : ParameterCollection;

begin

  pc := CoParameterCollection.Create;

  pc.AddOptionalAngularItem('an_optional_angular_item');

  pc.AddOptionalFloatItem('an_optional_float_item');

  pc.AddOptionalIntegerItem('an_optional_integer_item');

  pc.AddOptionalLinearItem('an_optional_linear_item');

  pc.AddOptionalStringItem('an_optional_string_item');

end;