Properties - HxGN SDx - Update 36 - Customization & Programming - Hexagon

HxGN SPClient Programming Guide

Language
English
Product
HxGN SDx
Search by Category
Customization & Programming

SPFURL

Read only. The SDx URL to which the current connection is made.

Data Type

String (maximum 128 characters)

Comments

None.

SPFPlant

Read only. The SDx plant name to which the current connection is made.

Data Type

String (maximum 254 characters)

Comments

None.

Connected

Read only. This property indicates whether there is an active connection to SDx or not. This property is set to TRUE by the Connect method. Tools can use this property to check if the object is connected to SDx.

Data Type

Boolean

Comments

None.

LastErrorMessage

Read only. Stores the error message generated by a method. Design tools should use this property to get the error message whenever a method returns a negative number indicating that the method has failed.

Data Type

String

Comments

None.

ToolParameters

A collection of tool parameters that the design tool has passed in the Connect call. The property is a System.Collections.Generic.Dictionary of ISPToolParameter objects. ISPToolParameter is a data class with Name (String) and Value (Object) properties.

Data Type

ISPToolParameters

Comments

None.

ToolProjectName

A read-only property used by the tool.

Data Type

String

Comments

None.

SPAdapter

This property is used to invoke the publishing tool's adapter method. This property returns the adapter object if instantiation is supplied by the publishing tool.

Data Type

ISPAdapter

Comments

None.