TIBCO FTL®
|
Properties objects represent a set of configuration properties (name and value pairs). More...
Public Member Functions | |
bool | Exists (string name) |
Check whether a property has been set. More... | |
bool | GetBoolean (string name) |
Get a boolean property. More... | |
double | GetDouble (string name) |
Get a double property. More... | |
int | GetInt (string name) |
Get an integer property. More... | |
long | GetLong (string name) |
Get an integer property. More... | |
IMessage | GetMessage (string name) |
Get a IMessage property. More... | |
string | GetString (string name) |
Get a string property. More... | |
bool | Remove (string name) |
Remove a property. More... | |
void | Set (string name, bool value) |
Set a boolean property. More... | |
void | Set (string name, string value) |
Set a string property. More... | |
void | Set (string name, int value) |
Set an integer property. More... | |
void | Set (String name, long value) |
Set an long property. More... | |
void | Set (String name, double value) |
Set a double property. More... | |
void | Set (string name, IMessage value) |
Set a IMessage property. More... | |
Properties objects represent a set of configuration properties (name and value pairs).
Programs pass properties objects to FTL object creation calls.
Customers do not implement this interface.
Each property name includes an indication of the required datatype for the value. For example, FTL.EVENTQUEUE_PROPERTY_INT_DISCARD_POLICY requires an integer value; FTL.REALM_PROPERTY_STRING_USERNAME requires a string value.
Set Method Semantics
name
is not yet in the properties object, Set
methods add the name and value pair. name
is already in the properties object Set
methods change its value. To create a properties object, call FTL.CreateProperties. Programs must IDisposable.Dispose properties objects to reclaim resources.
bool TIBCO.FTL.ITibProperties.Exists | ( | string | name | ) |
Check whether a property has been set.
name | The method checks for existence of this property. |
true
if the property is present, false
otherwise. bool TIBCO.FTL.ITibProperties.GetBoolean | ( | string | name | ) |
Get a boolean property.
name | The method gets the value of this property. |
double TIBCO.FTL.ITibProperties.GetDouble | ( | string | name | ) |
Get a double property.
name | The method gets the value of this property. |
int TIBCO.FTL.ITibProperties.GetInt | ( | string | name | ) |
Get an integer property.
name | The method gets the value of this property. |
long TIBCO.FTL.ITibProperties.GetLong | ( | string | name | ) |
Get an integer property.
name | The method gets the value of this property. |
IMessage TIBCO.FTL.ITibProperties.GetMessage | ( | string | name | ) |
Get a IMessage property.
name | The method gets the value of this property. |
string TIBCO.FTL.ITibProperties.GetString | ( | string | name | ) |
Get a string property.
name | The method gets the value of this property. |
bool TIBCO.FTL.ITibProperties.Remove | ( | string | name | ) |
Remove a property.
name | The method removes this property. |
true
if the method found and removed the property, false
if the property was not present. void TIBCO.FTL.ITibProperties.Set | ( | string | name, |
bool | value | ||
) |
Set a boolean property.
name | The method sets this property. |
value | The method sets the property to this value. |
void TIBCO.FTL.ITibProperties.Set | ( | string | name, |
string | value | ||
) |
Set a string property.
name | The method sets this property. |
value | The method sets the property to this value. |
void TIBCO.FTL.ITibProperties.Set | ( | string | name, |
int | value | ||
) |
Set an integer property.
name | The method sets this property. |
value | The method sets the property to this value. |
void TIBCO.FTL.ITibProperties.Set | ( | String | name, |
long | value | ||
) |
Set an long property.
name | The method sets this property. |
value | The method sets the property to this value. |
void TIBCO.FTL.ITibProperties.Set | ( | String | name, |
double | value | ||
) |
Set a double property.
name | The method sets this property. |
value | The method sets the property to this value. |