GetRootDatapoint

www.altova.com Print this Topic Previous Page Up One Level Next page

Home >  The MapForce API > Object Reference > Interfaces > Component > Methods >

GetRootDatapoint

Gets a root datapoint on the left (input) or right (output) side of a component. To access children and descendants, the Datapoint object provides further methods.

 

Signature

GetRootDatapoint(in side:ENUMComponentDatapointSide, in strNamespace:String, in strLocalName:String, in strParameterName:String) : Datapoint

 

Parameters

Name

Type

Description

side

ENUMComponentDatapointSide

The side parameter indicates if an input, or output, datapoint of a component is to be retrieved.

strNamespace

String

The specified namespace and local name, indicate the specific name of the node whose datapoint is to be retrieved. For components with structural information such as schema components, you will have to provide the namespace together with the local name, or you can just pass an empty string for the namespace.

 

File-based components like the schema component contain a special node on their root, the filename node. There, GetRootDatapoint can only find the filename node. You will have to pass namespace "http://www.altova.com/mapforce" and local name "FileInstance" to retrieve a datapoint of this node.

strLocalName

String

See above.

strParameterName

String

The specified parameter name should be an empty string unless the component in question is a function call component. Since a user-defined function might contain input or output parameters of the same structure, the function call component calling this user-defined function can have more than one root node with an identical namespace and local name.

 

They will then differ only by their parameter names, which are in fact the names of the according parameter components in the user-defined function mapping itself.

 

It is not mandatory to specify the parameter name, though. In that case, the method will return the first root datapoint matching the specified namespace and local name.

 

Errors

Error code

Description

1200

The object is no longer valid.

1201

Invalid address for the return parameter was specified.

1248

Datapoint not found.


© 2019 Altova GmbH