Version - Response
Please see the Legend to understand the conventions used to document each element and attribute. Note that for responses, the XML elements are documented in the order that they appear in the response.
| Element | Attributes |
|---|---|
<outVERSION> | |
<XMLDetail>[] | |
<SCEVersion> | |
<SCEXVersion> | |
<SCEPath> | |
<SCEXPath> | |
<DefaultDataDirPath> | |
<CurrentPath> |
🟥 <outVERSION>
| Element Type | Data Type |
|---|---|
| Parent | - |
This is the root element of the XML response, and is required. This element simply acts as a container for all of the result child elements.
Attributes: None
🟦 <XMLDetail>[]
| Element Type | Data Type | Default |
|---|---|---|
| Data | Text | NULL |
The <XMLDetail> elements are messages passed back to the calling application
which detail the status of the XML request. If the SCEX issues any warnings
regarding unrecognized elements or attributes, then each warning message will be
displayed in an <XMLDetail> element.
Attributes: None
🟥 <SCEVersion>
Contains the version information for the SCE. As discussed above, since the SCE
is now contained within the SCEX, the value of this element will always be
N/A.
Attributes: None
🟥 <SCEXVersion>
Contains the version information for the SCEX, as found in the SCEX library.
Attributes: None
🟥 <SCEPath>
Contains the fully qualified path for the SCE. Since the SCE is now contained
within the SCEX, the value of this element will always be N/A.
Attributes: None
🟥 <SCEXPath>
Contains the fully qualified path for the SCEX. That is, it specified the
location on the filesystem of the scex.dll or libscex.so in use. For the
Linux build of the SCEX, the value returned will be the path of the host
application using the SCEX library.
Attributes: None
🟥 <DefaultDataDirPath>
Contains the fully qualified path for the default directory in which the SCEX
will look for a data/ folder containing setup files. To temporarily override
the default data directory path for an XML request, specify a different
DataDirPath attribute when sending XML to the SCEX, or use one of the SCEX API
calls which allow the calling application to specify the default data directory
for the request. When the SCEX is first loaded, the default data directory is
initialized to the same value as that returned by the <SCEXPath> element
above.
Attributes: None
🟥 <CurrentPath>
Contains the fully qualified path for the current directory, as reported by the operating system.
Attributes: None