CogCoordinateSpaceTree.ParentName Method

CogCoordinateSpaceTree ParentName Method

Cognex VisionPro

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.VisionPro
Assembly: Cognex.VisionPro.Core (in Cognex.VisionPro.Core.dll) Version: 65.1.0.0

Syntax

public string ParentName(
	string spaceName,
	CogSpaceTreePathnameConstants pathnameFormat
)

public string ParentName(
	string spaceName,
	CogSpaceTreePathnameConstants pathnameFormat
)

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

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

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

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

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

pathnameFormat: Type: Cognex.VisionPro CogSpaceTreePathnameConstants
A CogSpaceTreePathnameConstants 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 CogSpaceTreePathnameConstants.
CogSpaceTreeInvalidNameSyntaxException	spaceName value is not a legal space name.
CogSpaceTreeNotUniqueException	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 "".