5.22.1 Plug-in loading and instantiation functions

Describes the following functions:

plugin_getInstantiationParameterInfo()

Gets the list of ParameterInfo used to instantiate instances of a plug-in.

Arguments

instId

Type: NumberU64

Opaque number uniquely identifying the target instance.

Return value

ResourceInfo[]

ResourceInfo for the instantiation parameters of the plug-in.

Errors

  • E_unknown_instance_id.

plugin_instantiate()

Instantiates a plug-in instance.

Arguments

instName

Type: String

Optional. Used to construct the instance name for the new instance. The instance name is "client.plugin.<instName>". If omitted, the plug-in factory chooses a suitable instance name.

paramValues

Type: InstantiationParameterValue[]

Optional. List of instantiation parameter values to use when instantiating the plug-in instance. Any parameters can be omitted and the paramValues argument can be omitted entirely. Any parameters that do not have a value set use their default value.

Return value

InstantiationResult

Indicates whether instantiation was successful and lists any errors and warnings that occurred during instantiation. See InstantiationResult.

Errors

  • E_unknown_instance_id.

plugin_load()

Loads a plug-in library.

Arguments

path

Type: String

Path to plug-in library to be loaded.

Return value

InstanceInfo[]

List of InstanceInfo for instances registered by this plug-in.

Errors

  • E_error_loading_plugin.
Non-ConfidentialPDF file icon PDF version101196_0100_03_en
Copyright © 2018, 2019 Arm Limited or its affiliates. All rights reserved.