Gettemplateexecutionstatus – Brocade Virtual ADX XML API Programmer’s Guide (Supporting ADX v03.1.00) User Manual

Page 91

Advertising
background image

Brocade Virtual ADX XML API Programmer’s Guide

81

53-1003248-01

Methods

3

Return value

Table 198

contains the return value for this method.

Error messages

List of Error Messages

getTemplateExecutionStatus

Description
Retrieves the template execution status and list of errors or warnings, if any.

Parameters
None.

Return values

Table 199

contains the return values for this method.

Error messages

List of Error Messages

startByteIndex

unsignedInt

Optional

Retrieves the
template content
from the specified
startByte index
position.

numberOfBytes

unsignedInt

Optional

Retrieves the
specified number of
bytes from the
template content.

TABLE 198

getTemplate return value

Name

Type

Description

templateContent

string

Returns the complete template XML content in a CDATA
wrapper.

bytesRead

unsignedInt

isEndOfFile

boolean

TABLE 199

Return values

Name

Type

Description

status

templateOperationStatusEnum

overallResult

templateResultTypeEnum

The overall result of the operation.

results

TemplateSummaryFilter

[ ]

Returns a collection of messages about the validation
results.

TABLE 197

getTemplate parameters

Parameter

Type

Presence

Rules

Description

Advertising