CogMisc.CheckSpaceNameSyntax Method

CogMisc CheckSpaceNameSyntax Method

Cognex VisionPro 9.7

Returns true if given space name has valid syntax, returns false otherwise. If not valid syntax, an error message is provided.

Namespace: Cognex.VisionPro
Assembly: Cognex.VisionPro.Core (in Cognex.VisionPro.Core.dll) Version: 73.0.0.0

Syntax

C++

Copy to Clipboard Print

public static bool CheckSpaceNameSyntax(
	string spaceName,
	bool allowPartialName,
	out string errMsg
)

public static bool CheckSpaceNameSyntax(
	string spaceName,
	bool allowPartialName,
	out string errMsg
)

Public Shared Function CheckSpaceNameSyntax ( 
	spaceName As String,
	allowPartialName As Boolean,
	<OutAttribute> ByRef errMsg As String
) As Boolean

Public Shared Function CheckSpaceNameSyntax ( 
	spaceName As String,
	allowPartialName As Boolean,
	<OutAttribute> ByRef errMsg As String
) As Boolean

public:
static bool CheckSpaceNameSyntax(
	String^ spaceName, 
	bool allowPartialName, 
	[OutAttribute] String^% errMsg
)

public:
static bool CheckSpaceNameSyntax(
	String^ spaceName, 
	bool allowPartialName, 
	[OutAttribute] String^% errMsg
)

Parameters

spaceName: Type: System String
The input space name to be verified.

allowPartialName: Type: System Boolean
If false, PQ names will be ruled invalid.

errMsg: Type: System String
If invalid syntax, an error message is provided.

Return Value

Type: Boolean
True if syntax is valid, false otherwise.

Remarks

Returns an empty string if the given coordinate space name has valid syntax. Otherwise, CheckSpaceNameSyntax(String, Boolean, String ) returns an explicit error message.