VCOM:VectorWorks:Filing:IXMLFileValidator::ValidateXMLName

.SDK|SDK ..SDK:Types|SDK Types ..VCOM:VCOM (Vectorworks Component Object Model)|VCOM Basics ..VCOM:Class Reference|VCOM Class Reference

Description

namespace VectorWorks::Filing

Member of VCOM:VectorWorks:Filing:IXMLFileValidator

Function fails if the name specified is not a valid XML name.

virtual VCOMError VCOM_CALLTYPE ValidateXMLName(
                         const TXString&   name) = 0;

Parameters

name

const TXString&

The name to be validated.

Return Value

Uses standard VCOM Error Reporting.

Return value meaning:

kVCOMError_NotInitialized		Bad VCOM instance used to call the fuction.
kVCOMError_Failed		Routine failed.

Remarks

This function is based on the definition of XML's NCName here: http://www.w3.org/TR/REC-xml/#sec-common-syn

The function is not Unicode-aware (only deals with the ASCII 0-127 subset). This, however, is not a problem, as VectorWork XML files should avoid non-ascii characters in NCNames.

See Also

VCOM:VectorWorks:Filing:IFolderIdentifier | VCOM:VectorWorks:Filing:IFileIdentifier | VCOM:VectorWorks:Filing:IXMLFileNode |

VCOM:VectorWorks:Filing:IXMLFile | VCOM:VectorWorks:Filing:IXMLFileValidator::CreateXMLName

[[VCOM:VectorWorks:Filing:IFolderIdentifier]] | [[VCOM:VectorWorks:Filing:IFileIdentifier]] | [[VCOM:VectorWorks:Filing:IXMLFileNode]] | [[VCOM:VectorWorks:Filing:IXMLFile]] | [[VCOM:VectorWorks:Filing:IXMLFileValidator::CreateXMLName]]