iDRS™ SDK 16
Loading...
Searching...
No Matches
CXmlOutputParams_interface.h File Reference

Interface for CXmlOutputParams wrapper. More...

Go to the source code of this file.

Functions

CXmlOutputParams CXmlOutputParams_Create (enum XmlSchema const evXmlSchema, idrs_exception *pargException)
 Create is instantiating a new instance of CXmlOutputParams and associated data object.
 
enum XmlSchema CXmlOutputParams_GetXmlSchema (const CXmlOutputParams argCXmlOutputParams, idrs_exception *pargException)
 getter for the XML schema.
 
void CXmlOutputParams_Destroy (CXmlOutputParams argCXmlOutputParams, idrs_exception *pargException)
 Destroys a CXmlOutputParams handle.
 

Detailed Description

Interface for CXmlOutputParams wrapper.

Function Documentation

◆ CXmlOutputParams_Create()

CXmlOutputParams CXmlOutputParams_Create ( enum XmlSchema const  evXmlSchema,
idrs_exception *  pargException 
)

Create is instantiating a new instance of CXmlOutputParams and associated data object.

Parameters
evXmlSchemaThe XML schema to use for output
pargExceptionPointer to exception structure that will be filled if an exception occurs
Returns
New instance of CXmlOutputParams
Remarks
Instances created by this method can also be provided to COutputParams methods

◆ CXmlOutputParams_Destroy()

void CXmlOutputParams_Destroy ( CXmlOutputParams  argCXmlOutputParams,
idrs_exception *  pargException 
)

Destroys a CXmlOutputParams handle.

Parameters
argCXmlOutputParamsCXmlOutputParams handle to destroy
pargExceptionPointer to exception structure that will be filled if an exception occurs

◆ CXmlOutputParams_GetXmlSchema()

enum XmlSchema CXmlOutputParams_GetXmlSchema ( const CXmlOutputParams  argCXmlOutputParams,
idrs_exception *  pargException 
)

getter for the XML schema.

Returns
the XML schema
Parameters
argCXmlOutputParamsCXmlOutputParams handle
pargExceptionPointer to exception structure that will be filled if an exception occurs