Functions
XML Schema

Functions

int mdlXMLSchemaCache_create (XmlSchemaCacheRef *pSchemaCacheRef)
 Creates an instance of a XML Schema Cache. More...
 
int mdlXMLSchemaCache_createWithSchema (XmlSchemaCacheRef *pSchemaCacheRef, WChar const *pXMLNSTarget, WChar const *pSchemaFilename)
 Creates an instance of a XML Schema Cache with the given file name. More...
 
int mdlXMLSchemaCache_free (XmlSchemaCacheRef schemaCacheRef)
 Frees an instance of a XML Schema Cache. More...
 
int mdlXMLSchemaCache_getValidateError (long *pErrorCode, long *pFilepos, long *pLine, long *pLinepos, WCharP pReason, int maxReasonLength, WCharP pSrcText, int maxSrcTextLength, WCharP pUrl, int maxUrlLength, XmlSchemaCacheRef schemaCacheRef)
 Returns the last validate error if one of the dom creation function fails. More...
 
long mdlXMLSchemaCache_getSchemaCount (XmlSchemaCacheRef schemaCacheRef)
 Returns the number of schema in the given XML Schema Cache. More...
 
int mdlXMLSchemaCache_addSchemaByDom (XmlSchemaCacheRef schemaCacheRef, WChar const *pXMLNSTarget, XmlDomRef pSchemaDom)
 Adds a XML Schema DOM to the given Schema Cache. More...
 
int mdlXMLSchemaCache_addSchemaByFilename (XmlSchemaCacheRef schemaCacheRef, WChar const *pXMLNSTarget, WChar const *pSchemaFilename)
 Adds a schema to the given Schema Cache. More...
 
int mdlXMLSchemaCache_removeSchema (XmlSchemaCacheRef schemaCacheRef, WChar const *pXMLNSTarget)
 Removes a schema from the given schema cache. More...
 
int mdlXMLSchemaCache_getSchema (XmlSchemaRef *pSchemaRef, XmlSchemaCacheRef schemaCacheRef, WChar const *pXMLNSTarget)
 Returns the XML Schema that corresponds to the given namespace target. More...
 
int mdlXMLSchemaCache_getNamespaceByIndex (WChar *pNamespace, long *pMaxChars, XmlSchemaCacheRef schemaCacheRef, long index)
 Returns the namespace at the index of the given schema cache. More...
 
int mdlXMLSchemaCache_getSchemaItemByXPath (XmlSchemaItemRef *pSchemaItemRef, XmlSchemaCacheRef schemaCacheRef, WChar const *pXMLNSTarget, WChar const *pXPath)
 Returns a schema Item defined by its Path in the XML Schema Cache. More...
 
int mdlXMLSchema_free (XmlSchemaRef schemaRef)
 Frees an instance of an XML Schema. More...
 
int mdlXMLSchema_getSchemaItemsList (XmlSchemaItemsListRef *pSchemaItemsListRef, XmlSchemaRef schemaRef, int listType)
 Returns the XML Schema Items List of type listype from the give XML Schema. More...
 
int mdlXMLSchemaList_free (XmlSchemaItemsListRef schemaItemsListRef)
 Frees an instance of XML Schema Items List. More...
 
long mdlXMLSchemaList_getNumItems (XmlSchemaItemsListRef schemaItemsListRef)
 Returns the number of items in the given XML Schema Items List. More...
 
int mdlXMLSchemaList_getItem (XmlSchemaItemRef *pSchemaItemRef, XmlSchemaItemsListRef schemaItemsListRef, long index)
 Returns the XML Schema Item at the given index of the XML Schema List. More...
 
int mdlXMLSchemaList_getItemByName (XmlSchemaItemRef *pSchemaItemRef, XmlSchemaItemsListRef schemaItemsListRef, WChar const *pName)
 Returns a XML Schema Item by name from the given XML Schema List. More...
 
int mdlXMLSchemaList_getItemByQName (XmlSchemaItemRef *pSchemaItemRef, XmlSchemaItemsListRef schemaItemsListRef, WChar const *pName, WChar const *pNamespaceURI)
 Returns a XML Schema Item by qualified name from the given XML Schema List. More...
 
int mdlXMLSchemaItem_free (XmlSchemaItemRef schemaItemRef)
 Frees an instance of an XML Schema Item. More...
 
long mdlXMLSchemaItem_getItemType (XmlSchemaItemRef schemaItemRef)
 Returns the item Type of the given XML Schema Item. More...
 
bool mdlXMLSchemaItem_isSimpleType (XmlSchemaItemRef schemaItemRef)
 Returns true if the given schema item is a simple type. More...
 
int mdlXMLSchemaItem_getSchemaType (XmlSchemaTypeRef *pSchemaTypeRef, XmlSchemaItemRef schemaItemRef)
 Returns the Schema Type for the given Schema Item. More...
 
int mdlXMLSchemaType_getDataTypeName (WChar *pDataTypeName, int *pMaxCharsDataTypeName, XmlSchemaTypeRef schemaTypeRef)
 Returns the datatype for the given schema type. More...
 
long mdlXMLSchemaType_getNumBaseTypes (XmlSchemaTypeRef schemaTypeRef)
 Returns the number of Base Types from the given XML Schema Type. More...
 
int mdlXMLSchemaType_getBaseType (XmlSchemaTypeRef *pSchemaTypeRef, XmlSchemaTypeRef schemaTypeRef, long index)
 Returns the XML Schema Base Type for the given Schema Item. More...
 
int mdlXMLSchemaType_getDigitFacets (long *pTotalDigits, long *pFractionDigits, XmlSchemaTypeRef schemaTypeRef)
 Returns the digit facets for the given schema type. More...
 
bool mdlXMLSchemaType_isEnumeration (XmlSchemaStringsListRef *pEnumListRef, XmlSchemaTypeRef schemaTypeRef)
 Returns a strings list of the enum types for the given schema type, if the given schema type is an enumeration. More...
 
int mdlXMLSchemaType_getEnumerationFacets (XmlSchemaStringsListRef *pSchemaEnumerationList, XmlSchemaTypeRef schemaTypeRef)
 Returns the enumeration facets for the given schema type. More...
 
int mdlXMLSchemaType_getLengthFacets (long *pLength, long *pMinLength, long *pMaxLength, XmlSchemaTypeRef schemaTypeRef)
 Returns the length facets for the given schema type. More...
 
int mdlXMLSchemaType_getMinMaxFacets (WChar *pMinExclusive, int *pMinExclusiveMaxChars, WChar *pMaxExclusive, int *pMaxExclusiveMaxChars, WChar *pMinInclusive, int *pMinInclusiveMaxChars, WChar *pMaxInclusive, int *pMaxInclusiveMaxChars, XmlSchemaTypeRef schemaTypeRef)
 Returns the min/max facets for the given schema type. More...
 
int mdlXMLSchemaType_getPatternFacets (XmlSchemaStringsListRef *pSchemaPatternsList, XmlSchemaTypeRef schemaTypeRef)
 Returns the pattern facets for the given schema type. More...
 
bool mdlXMLSchemaType_isValid (XmlSchemaTypeRef schemaTypeRef, WChar const *pStringToValidate)
 Returns true is the given string is validfor the given schema type. More...
 
int mdlXMLSchemaItem_getName (WChar *pNameValue, int *pMaxChars, XmlSchemaItemRef schemaItemRef)
 Returns the name for the given schema Item. More...
 
int mdlXMLSchemaItem_getDefaultValue (WChar *pDefaultValue, int *pMaxChars, XmlSchemaItemRef schemaItemRef)
 Returns the default value for the given schema, if it has one. More...
 
int mdlXMLSchemaItem_getFixedValue (WChar *pFixedValue, int *pMaxChars, XmlSchemaItemRef schemaItemRef)
 Returns the fixed value for the given schema, if it has one. More...
 
bool mdlXMLSchemaItem_isReference (XmlSchemaItemRef schemaItemRef)
 Returns true if the given schema item is a reference. More...
 
bool mdlXMLSchemaElement_isAbstract (XmlSchemaItemRef schemaItemRef)
 Returns true if the given schema item is an abstract schema item. More...
 
bool mdlXMLSchemaElement_isNillable (XmlSchemaItemRef schemaItemRef)
 Returns true if the given schema element item is able to be NULL. More...
 
bool mdlXMLSchemaAttribute_isRequired (XmlSchemaItemRef schemaItemRef)
 Returns true if the given attrribute item is a required attribute. More...
 
bool mdlXMLSchemaAttribute_isOptional (XmlSchemaItemRef schemaItemRef)
 Returns true if the given attrribute item is an optional attribute. More...
 
bool mdlXMLSchemaAttribute_isProhibited (XmlSchemaItemRef schemaItemRef)
 Returns true if the given schema attribute item is prohibited. More...
 
int mdlXMLSchemaElement_getChildElements (XmlSchemaItemsListRef *pSchemaItemsListRef, long *numChildElements, XmlSchemaItemRef schemaItemRef)
 Returns an XML Schema Elements List. More...
 
int mdlXMLSchemaElement_getAttributes (XmlSchemaItemsListRef *pSchemaItemsListRef, long *numAttributes, XmlSchemaItemRef schemaItemRef)
 Returns an XML Schema Elements List. More...
 
int mdlXMLSchemaType_free (XmlSchemaTypeRef schemaTypeRef)
 Frees an instance an XML Schema Type. More...
 
int mdlXMLSchemaStringsList_free (XmlSchemaStringsListRef schemaStringsListRef)
 Frees a XML Schema Strings List. More...
 
long mdlXMLSchemaStringsList_getNumStrings (XmlSchemaStringsListRef schemaStringsListRef)
 Returns the number of strings in the given XML Schema Strings List. More...
 
int mdlXMLSchemaStringsList_getString (WChar *pSchemaString, int *pMaxChars, XmlSchemaStringsListRef schemaStringsListRef, long index)
 Returns the string at given index of the given schema string list. More...
 

Detailed Description

Function Documentation

int mdlXMLSchema_free ( XmlSchemaRef  schemaRef)

Frees an instance of an XML Schema.

Parameters
[in]schemaRefReference to a XML Schema Cache
Returns
SUCCESS or ERROR
int mdlXMLSchema_getSchemaItemsList ( XmlSchemaItemsListRef pSchemaItemsListRef,
XmlSchemaRef  schemaRef,
int  listType 
)

Returns the XML Schema Items List of type listype from the give XML Schema.

Parameters
[out]pSchemaItemsListRefReturned XML Schema Items List
[in]schemaRefReference to a XML Schema Cache
[in]listTypeList Type (one of SCHEMAITEMSLIST_ELEMENTS, SCHEMAITEMSLIST_ATTRIBUTES, SCHEMAITEMSLIST_TYPES) to return
Returns
SUCCESS or ERROR
Remarks
pSchemaItemsListRef must be freed using mdlXMLSchemaList_free
See also
mdlXMLSchemaList_free
Remarks
listType(s) are defined in mdlxmltools.h
bool mdlXMLSchemaAttribute_isOptional ( XmlSchemaItemRef  schemaItemRef)

Returns true if the given attrribute item is an optional attribute.

Parameters
[in]schemaItemRefReference to Schema Attribute Item class
Returns
true or false
bool mdlXMLSchemaAttribute_isProhibited ( XmlSchemaItemRef  schemaItemRef)

Returns true if the given schema attribute item is prohibited.

Parameters
[in]schemaItemRefReference to Schema Attribute Item class
Returns
true or false
bool mdlXMLSchemaAttribute_isRequired ( XmlSchemaItemRef  schemaItemRef)

Returns true if the given attrribute item is a required attribute.

Parameters
[in]schemaItemRefReference to Schema Attribute Item class
Returns
true or false
int mdlXMLSchemaCache_addSchemaByDom ( XmlSchemaCacheRef  schemaCacheRef,
WChar const *  pXMLNSTarget,
XmlDomRef  pSchemaDom 
)

Adds a XML Schema DOM to the given Schema Cache.

Parameters
[in]schemaCacheRefReference to a XML Schema Cache
[in]pXMLNSTargetAssociated Namespace with newly added schema
[in]pSchemaDomXML DOM of Schema to load into XML Schema Cache
Returns
SUCCESS or ERROR
int mdlXMLSchemaCache_addSchemaByFilename ( XmlSchemaCacheRef  schemaCacheRef,
WChar const *  pXMLNSTarget,
WChar const *  pSchemaFilename 
)

Adds a schema to the given Schema Cache.

Parameters
[in]schemaCacheRefReference to a XML Schema Cache
[in]pXMLNSTargetAssociated Namespace with newly added schema
[in]pSchemaFilenameSchema to load into XML Schema Cache
Returns
SUCCESS or ERROR
int mdlXMLSchemaCache_create ( XmlSchemaCacheRef pSchemaCacheRef)

Creates an instance of a XML Schema Cache.

Parameters
[out]pSchemaCacheRefNewly created XML Schema Cache
Returns
SUCCESS or ERROR
Remarks
pSchemaCacheRef must be freed using mdlXMLSchemaCache_free
See also
mdlXMLSchemaCache_free
int mdlXMLSchemaCache_createWithSchema ( XmlSchemaCacheRef pSchemaCacheRef,
WChar const *  pXMLNSTarget,
WChar const *  pSchemaFilename 
)

Creates an instance of a XML Schema Cache with the given file name.

Parameters
[out]pSchemaCacheRefNewly created XML Schema Cache
[in]pXMLNSTargetNamespace of associated schema to add
[in]pSchemaFilenameSchema to load into XML Schema Cache
Returns
SUCCESS or ERROR
Remarks
pSchemaCacheRef must be freed using mdlXMLSchemaCache_free
See also
mdlXMLSchemaCache_free
int mdlXMLSchemaCache_free ( XmlSchemaCacheRef  schemaCacheRef)

Frees an instance of a XML Schema Cache.

Parameters
[in]schemaCacheRefReference to a XML Schema Cache
Returns
SUCCESS or ERROR
int mdlXMLSchemaCache_getNamespaceByIndex ( WChar *  pNamespace,
long *  pMaxChars,
XmlSchemaCacheRef  schemaCacheRef,
long  index 
)

Returns the namespace at the index of the given schema cache.

Parameters
[out]pNamespaceReturned namespace name
[in,out]pMaxCharsMax. Number of charst to return, actual number of chars is returned
[in]schemaCacheRefReference to a XML Schema Cache
[in]indexThe index of the namespace to be retrieved
Returns
SUCCESS or ERROR
int mdlXMLSchemaCache_getSchema ( XmlSchemaRef pSchemaRef,
XmlSchemaCacheRef  schemaCacheRef,
WChar const *  pXMLNSTarget 
)

Returns the XML Schema that corresponds to the given namespace target.

Parameters
[out]pSchemaRefReturned XML Schema that correspondes to given namespace
[in]schemaCacheRefReference to a XML Schema Cache
[in]pXMLNSTargetNamespace of associated schema to get
Returns
SUCCESS or ERROR
Remarks
pSchemaRef must be freed using mdlXMLSchema_free
See also
mdlXMLSchema_free
long mdlXMLSchemaCache_getSchemaCount ( XmlSchemaCacheRef  schemaCacheRef)

Returns the number of schema in the given XML Schema Cache.

Parameters
[in]schemaCacheRefReference to a XML Schema Cache
Returns
SUCCESS or ERROR
int mdlXMLSchemaCache_getSchemaItemByXPath ( XmlSchemaItemRef pSchemaItemRef,
XmlSchemaCacheRef  schemaCacheRef,
WChar const *  pXMLNSTarget,
WChar const *  pXPath 
)

Returns a schema Item defined by its Path in the XML Schema Cache.

Parameters
[out]pSchemaItemRefReturned XML Schema Item
[in]schemaCacheRefReference to a XML Schema Cache
[in]pXMLNSTargetNamespace of associated schema
[in]pXPathXpath criteria to get schema Item
Returns
SUCCESS or ERROR
int mdlXMLSchemaCache_getValidateError ( long *  pErrorCode,
long *  pFilepos,
long *  pLine,
long *  pLinepos,
WCharP  pReason,
int  maxReasonLength,
WCharP  pSrcText,
int  maxSrcTextLength,
WCharP  pUrl,
int  maxUrlLength,
XmlSchemaCacheRef  schemaCacheRef 
)

Returns the last validate error if one of the dom creation function fails.

Parameters
[out]pErrorCodeContains the error code of the last parse error, or NULL if NOT wanted
[out]pFileposContains the absolute file position where the error occurred, or NULL if NOT wanted
[out]pLineSpecifies the line number that contains the error, or NULL if NOT wanted
[out]pLineposContains the character position within the line where the error occurred, or NULL if NOT wanted
[out]pReasonDescribes the reason for the error, or NULL if NOT wanted
[in]maxReasonLengthMax length of pReason to return, if pReason is not NULL
[out]pSrcTextReturns the text of the line containing the error, or NULL if NOT wanted
[in]maxSrcTextLengthMax length of pSrcText to return, if pSrcText is not NULL
[out]pUrlReturns the URL of the XML document containing the last error, or NULL if NOT wanted
[in]maxUrlLengthMax length of pUrl to return, if pUrl is not NULL
[in]schemaCacheRefReference to a XML Schema Cache
Returns
SUCCESS or ERROR
int mdlXMLSchemaCache_removeSchema ( XmlSchemaCacheRef  schemaCacheRef,
WChar const *  pXMLNSTarget 
)

Removes a schema from the given schema cache.

Parameters
[in]schemaCacheRefReference to a XML Schema Cache
[in]pXMLNSTargetNamespace of associated schema to be removed
Returns
SUCCESS or ERROR
int mdlXMLSchemaElement_getAttributes ( XmlSchemaItemsListRef pSchemaItemsListRef,
long *  numAttributes,
XmlSchemaItemRef  schemaItemRef 
)

Returns an XML Schema Elements List.

Parameters
[out]pSchemaItemsListRefReturned List of XML Schema Element List
[out]numAttributesReturned number of XML Attributes in list
[in]schemaItemRefReference to Schema Element Item class
Returns
SUCCESS or ERROR
int mdlXMLSchemaElement_getChildElements ( XmlSchemaItemsListRef pSchemaItemsListRef,
long *  numChildElements,
XmlSchemaItemRef  schemaItemRef 
)

Returns an XML Schema Elements List.

Parameters
[out]pSchemaItemsListRefReturned List of XML Schema Element List
[out]numChildElementsReturned number of XML Child Elements in list
[in]schemaItemRefReference to Schema Element Item class
Returns
SUCCESS or ERROR
bool mdlXMLSchemaElement_isAbstract ( XmlSchemaItemRef  schemaItemRef)

Returns true if the given schema item is an abstract schema item.

Parameters
[in]schemaItemRefReference to Schema Element Item class
Returns
true or false
bool mdlXMLSchemaElement_isNillable ( XmlSchemaItemRef  schemaItemRef)

Returns true if the given schema element item is able to be NULL.

Parameters
[in]schemaItemRefReference to Schema Element Item class
Returns
true or false
int mdlXMLSchemaItem_free ( XmlSchemaItemRef  schemaItemRef)

Frees an instance of an XML Schema Item.

Parameters
[in]schemaItemRefReference to Schema Item class
Returns
SUCCESS or ERROR
int mdlXMLSchemaItem_getDefaultValue ( WChar *  pDefaultValue,
int *  pMaxChars,
XmlSchemaItemRef  schemaItemRef 
)

Returns the default value for the given schema, if it has one.

Parameters
[in,out]pDefaultValueReturned default value
[in,out]pMaxCharsMax. number of chars of pDefaultValue to return, actual number of chars in pDefaultValue returned
[in]schemaItemRefReference to Schema Item class
Returns
returns SUCCESS if schemaItem has a default value, otherwise ERROR
int mdlXMLSchemaItem_getFixedValue ( WChar *  pFixedValue,
int *  pMaxChars,
XmlSchemaItemRef  schemaItemRef 
)

Returns the fixed value for the given schema, if it has one.

Parameters
[in,out]pFixedValueReturned fixed value
[in,out]pMaxCharsMax. number of chars of pFixedValue to return, actual number of chars in pFixedValue returned
[in]schemaItemRefReference to Schema Item class
Returns
returns SUCCESS if schemaItem has a default value, otherwise ERROR
long mdlXMLSchemaItem_getItemType ( XmlSchemaItemRef  schemaItemRef)

Returns the item Type of the given XML Schema Item.

Parameters
[in]schemaItemRefReference to Schema Item class
Returns
SUCCESS or ERROR
int mdlXMLSchemaItem_getName ( WChar *  pNameValue,
int *  pMaxChars,
XmlSchemaItemRef  schemaItemRef 
)

Returns the name for the given schema Item.

Parameters
[in,out]pNameValueReturned value of named attribute returned as the attribute type
[in,out]pMaxCharsMax. number of chars of pNameValue to return, actual number of chars in pNameValue returned
[in]schemaItemRefReference to Schema Item class
Returns
SUCCESS or ERROR
int mdlXMLSchemaItem_getSchemaType ( XmlSchemaTypeRef pSchemaTypeRef,
XmlSchemaItemRef  schemaItemRef 
)

Returns the Schema Type for the given Schema Item.

Parameters
[out]pSchemaTypeRefReturned Schema Type
[in]schemaItemRefReference to Schema Item class
Returns
SUCCESS or ERROR
Remarks
pSchemaTypeRef must be freed by calling mdlXMLSchemaType_free
See also
mdlXMLSchemaType_free
bool mdlXMLSchemaItem_isReference ( XmlSchemaItemRef  schemaItemRef)

Returns true if the given schema item is a reference.

Parameters
[in]schemaItemRefReference to Schema Item class
Returns
true or false
bool mdlXMLSchemaItem_isSimpleType ( XmlSchemaItemRef  schemaItemRef)

Returns true if the given schema item is a simple type.

Parameters
[in]schemaItemRefReference to Schema Item class
Returns
true or false
int mdlXMLSchemaList_free ( XmlSchemaItemsListRef  schemaItemsListRef)

Frees an instance of XML Schema Items List.

Parameters
[in]schemaItemsListRefreference to a XML Schema Items List
Returns
SUCCESS or ERROR
int mdlXMLSchemaList_getItem ( XmlSchemaItemRef pSchemaItemRef,
XmlSchemaItemsListRef  schemaItemsListRef,
long  index 
)

Returns the XML Schema Item at the given index of the XML Schema List.

Parameters
[out]pSchemaItemRefReturned XML Schema Item
[in]schemaItemsListRefreference to a XML Schema Items List
[in]indexthe index of the schema item list to be retrieved
Remarks
pSchemaItemRef must be freed using mdlXMLSchemaItem_free
See also
mdlXMLSchemaItem_free
Returns
SUCCESS or ERROR
int mdlXMLSchemaList_getItemByName ( XmlSchemaItemRef pSchemaItemRef,
XmlSchemaItemsListRef  schemaItemsListRef,
WChar const *  pName 
)

Returns a XML Schema Item by name from the given XML Schema List.

Parameters
[out]pSchemaItemRefReturned XML Schema Item
[in]schemaItemsListRefReference to a XML Schema Items List
[in]pNameName to search for XML Schema Item
Remarks
pSchemaItemRef must be freed using mdlXMLSchemaItem_free
See also
mdlXMLSchemaItem_free
Returns
SUCCESS or ERROR
int mdlXMLSchemaList_getItemByQName ( XmlSchemaItemRef pSchemaItemRef,
XmlSchemaItemsListRef  schemaItemsListRef,
WChar const *  pName,
WChar const *  pNamespaceURI 
)

Returns a XML Schema Item by qualified name from the given XML Schema List.

Parameters
[out]pSchemaItemRefReturned XML Schema Item
[in]schemaItemsListRefReference to a XML Schema Items List
[in]pNameName to search for XML Schema Item
[in]pNamespaceURINamespace URI to search for XML Schema Item
Returns
SUCCESS or ERROR
Remarks
pSchemaItemRef must be freed using mdlXMLSchemaItem_free
See also
mdlXMLSchemaItem_free
long mdlXMLSchemaList_getNumItems ( XmlSchemaItemsListRef  schemaItemsListRef)

Returns the number of items in the given XML Schema Items List.

Parameters
[in]schemaItemsListRefreference to a XML Schema Items List
Returns
SUCCESS or ERROR
int mdlXMLSchemaStringsList_free ( XmlSchemaStringsListRef  schemaStringsListRef)

Frees a XML Schema Strings List.

Parameters
[in]schemaStringsListRefReference to a XML Schema Strings List
Returns
SUCCESS or ERROR
long mdlXMLSchemaStringsList_getNumStrings ( XmlSchemaStringsListRef  schemaStringsListRef)

Returns the number of strings in the given XML Schema Strings List.

Parameters
[in]schemaStringsListRefreference to a XML Schema Strings List
Returns
SUCCESS or ERROR
int mdlXMLSchemaStringsList_getString ( WChar *  pSchemaString,
int *  pMaxChars,
XmlSchemaStringsListRef  schemaStringsListRef,
long  index 
)

Returns the string at given index of the given schema string list.

Parameters
[in,out]pSchemaStringReturned string at given index in schema string list
[in,out]pMaxCharsMax. number of chars of pSchemaString to return, actual number of chars in pSchemaString returned
[in]schemaStringsListRefReference to a XML Schema Strings List
[in]indexIndex of the schema string list to be retrieved
Returns
SUCCESS or ERROR
int mdlXMLSchemaType_free ( XmlSchemaTypeRef  schemaTypeRef)

Frees an instance an XML Schema Type.

Parameters
[in]schemaTypeRefReference to Schema Type class
Returns
SUCCESS or ERROR
int mdlXMLSchemaType_getBaseType ( XmlSchemaTypeRef pSchemaTypeRef,
XmlSchemaTypeRef  schemaTypeRef,
long  index 
)

Returns the XML Schema Base Type for the given Schema Item.

Parameters
[out]pSchemaTypeRefReturned Schema Type
[in]schemaTypeRefReference to Schema Type class
[in]indexIndex of the base type list to be retrieved
Returns
SUCCESS or ERROR
Remarks
pSchemaTypeRef must be freed by calling mdlXMLSchemaType_free
See also
mdlXMLSchemaType_free
int mdlXMLSchemaType_getDataTypeName ( WChar *  pDataTypeName,
int *  pMaxCharsDataTypeName,
XmlSchemaTypeRef  schemaTypeRef 
)

Returns the datatype for the given schema type.

Parameters
[out]pDataTypeNameReference to XML Schema Type class
[in,out]pMaxCharsDataTypeNameMax. number of chars of pDataTypeName to return, actual number of chars in pValue returned
[in]schemaTypeRefReference to XML Schema Type class
Returns
SUCCESS or ERROR
int mdlXMLSchemaType_getDigitFacets ( long *  pTotalDigits,
long *  pFractionDigits,
XmlSchemaTypeRef  schemaTypeRef 
)

Returns the digit facets for the given schema type.

Parameters
[in,out]pTotalDigitsReturned Total Digits Facet, or NULL
[in,out]pFractionDigitsReturned Total Fractional Facet, or NULL
[in]schemaTypeRefReference to Schema Type class
Returns
SUCCESS or ERROR
int mdlXMLSchemaType_getEnumerationFacets ( XmlSchemaStringsListRef pSchemaEnumerationList,
XmlSchemaTypeRef  schemaTypeRef 
)

Returns the enumeration facets for the given schema type.

Parameters
[in]pSchemaEnumerationListXML Schema Strings Enumeration List
[in]schemaTypeRefReference to Schema Type class
Returns
SUCCESS or ERROR
Remarks
pSchemaEnumerationList must be freed by mdlXMLSchemaStringsList_free
See also
mdlXMLSchemaStringsList_free
int mdlXMLSchemaType_getLengthFacets ( long *  pLength,
long *  pMinLength,
long *  pMaxLength,
XmlSchemaTypeRef  schemaTypeRef 
)

Returns the length facets for the given schema type.

Parameters
[in,out]pLengthReturned Length Facet, or NULL
[in,out]pMinLengthReturned Minimum Length Facet, or NULL
[in,out]pMaxLengthReturned Maximum Length Facet, or NULL
[in]schemaTypeRefReference to Schema Type class
Returns
SUCCESS or ERROR
int mdlXMLSchemaType_getMinMaxFacets ( WChar *  pMinExclusive,
int *  pMinExclusiveMaxChars,
WChar *  pMaxExclusive,
int *  pMaxExclusiveMaxChars,
WChar *  pMinInclusive,
int *  pMinInclusiveMaxChars,
WChar *  pMaxInclusive,
int *  pMaxInclusiveMaxChars,
XmlSchemaTypeRef  schemaTypeRef 
)

Returns the min/max facets for the given schema type.

Parameters
[in,out]pMinExclusiveReturned Min Exclusive Facet, or NULL
[in,out]pMinExclusiveMaxCharsMax. Number of chars to return in pMinExclusive, actual size of pMinExclusive
[in,out]pMaxExclusiveReturned Max Exclusive Facet, or NULL
[in,out]pMaxExclusiveMaxCharsMax. Number of chars to return in pMaxExclusive, actual size of pMaxExclusive
[in,out]pMinInclusiveReturned Min Inclusive Facet, or NULL
[in,out]pMinInclusiveMaxCharsMax. Number of chars to return in pMinInclusive, actual size of pMinInclusive
[in,out]pMaxInclusiveReturned Max Inclusive Facet, or NULL
[in,out]pMaxInclusiveMaxCharsMax. Number of chars to return in pMaxInclusive, actual size of pMaxInclusive
[in]schemaTypeRefReference to Schema Type class
Returns
returns SUCCESS if schema type has at least one min/max facet, otherwise ERROR
long mdlXMLSchemaType_getNumBaseTypes ( XmlSchemaTypeRef  schemaTypeRef)

Returns the number of Base Types from the given XML Schema Type.

Parameters
[in]schemaTypeRefReference to XML Schema Type class
Returns
SUCCESS or ERROR
int mdlXMLSchemaType_getPatternFacets ( XmlSchemaStringsListRef pSchemaPatternsList,
XmlSchemaTypeRef  schemaTypeRef 
)

Returns the pattern facets for the given schema type.

Parameters
[in]pSchemaPatternsListXML Schema Strings Enumeration List
[in]schemaTypeRefReference to Schema Type class
Returns
SUCCESS or ERROR
Remarks
pSchemaPatternsList must be freed by mdlXMLSchemaStringsList_free
See also
mdlXMLSchemaStringsList_free
bool mdlXMLSchemaType_isEnumeration ( XmlSchemaStringsListRef pEnumListRef,
XmlSchemaTypeRef  schemaTypeRef 
)

Returns a strings list of the enum types for the given schema type, if the given schema type is an enumeration.

Parameters
[out]pEnumListRefReturned XML Schema Strings Enumeration List, if schema type is an enumeration
[in]schemaTypeRefReference to Schema Type class
Returns
true or false
Remarks
pEnumListRef must be freed by mdlXMLSchemaStringsList_free, pEnumListRef is set to NULL if schema type is not an enumeration type
See also
mdlXMLSchemaStringsList_free
bool mdlXMLSchemaType_isValid ( XmlSchemaTypeRef  schemaTypeRef,
WChar const *  pStringToValidate 
)

Returns true is the given string is validfor the given schema type.

Parameters
[in]schemaTypeRefReference to Schema Type class
[in]pStringToValidatestring to validate
Returns
true if pStringToValidate is valid for this type, false otherwise

Copyright © 2017 Bentley Systems, Incorporated. All rights reserved.