FME Server .NET API

IFMETransformationResult.GetStringProperty Method 

Gets a string value from the FME Server or FME Server response.

[Visual Basic]
Function GetStringProperty( _
   ByVal propName As String _
) As String
[C#]
string GetStringProperty(
   string propName
);

Parameters

propName
The name of a property to look up in the FME Engine or FME Server response.

Return Value

Returns a string representation of the property's value.

Remarks

Properties defined in the FME Server response will shadow any properties by the same name in the FME Server response. For example, if both the FME Server and FME Server response define a property called "username", then getBooleanProperty("username") will return the corresponding value from the FME Server response, not the FME Server response. If a property is defined multiple times in the FME Server response, the last value in the response string will be used.

The following string properties should be present in the FME Server response:

The following string properties are included in the default SUCCESS_RESPONSE and FAILURE_RESPONSE directives that ship with the FME Server:

Exceptions

Exception TypeCondition
Safe.FMEServer.API.FMEServerExceptionThe property could not be found.

See Also

IFMETransformationResult Interface | IFMETransformationResult Members | Safe.FMEServer.API Namespace