CoordinateSpaceTree.ParentName Method

CoordinateSpaceTree ParentName Method

Cognex VisionPro 9.22 SR1

Returns the name of the given space's parent. The parent name for the root space is the empty name ("") because the root space has no parent.

Namespace: Cognex.Vision
Assembly: Cognex.Vision.Core.Net (in Cognex.Vision.Core.Net.dll) Version: 9.22.2.0

Syntax

public string ParentName(
	string spaceName,
	SpaceTreePathnameConstants pathnameFormat
)

public string ParentName(
	string spaceName,
	SpaceTreePathnameConstants pathnameFormat
)

Public Function ParentName ( 
	spaceName As String,
	pathnameFormat As SpaceTreePathnameConstants
) As String

Public Function ParentName ( 
	spaceName As String,
	pathnameFormat As SpaceTreePathnameConstants
) As String

public:
String^ ParentName(
	String^ spaceName, 
	SpaceTreePathnameConstants pathnameFormat
)

public:
String^ ParentName(
	String^ spaceName, 
	SpaceTreePathnameConstants pathnameFormat
)

spaceName: Type: System String
A valid nonqualified or fully-qualified space name to find in this coordinate space tree.

pathnameFormat: Type: Cognex.Vision SpaceTreePathnameConstants
A SpaceTreePathnameConstants value that indicates how the returned name should be formatted.

Type: String

The parent space name.

Exceptions

Exception	Condition
ArgumentException	pathnameFormat value is not a member of SpaceTreePathnameConstants.
SpaceTreeException	spaceName value is not a legal space name.
SpaceTreeException	spaceName is a nonqualified space name and more than one instance of it exists in this tree.

Remarks

Returns the name of the given space's parent. Because the root space has no parent, its parent space name is the empty name string "".