Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Current »


 
Returns all the XML Configuration data of an XML Configuration specified by its XML Configuration Id.
Related functions: edmiRemoteCreateXMLConfiguration , edmiRemoteDeleteXMLConfiguration , edmiRemoteGetXMLConfigurationId, edmiRemoteListXMLConfigurations, edmiRemoteReadXMLDocument, edmiRemoteReadXMLFile, edmiRemoteWriteXMLDocument, edmiRemoteWriteXMLFile.
Header:
#include "sdai.h"
Prototype:
EdmiError edmiRemoteGetXMLConfiguration(SdaiServerContext serverContextId, 
                                         SdaiString        schemaName, 
                                         SdaiString        xmlConfigurationName, 
                                         SdaiInstance      *xmlConfigurationId, 
                                         SdaiString        *xmlConfigurationString, 
                                         SdaiString        *nameSpace, 
                                         SdaiString        *nameSpaceAlias, 
                                         SdaiString        *xmlSchemaURL,
                                         SdaiInvocationId  *edmiInvocationId);
 
Arguments:

serverContextId

Context identification, from edmiDefineServerContext

schemaName

The name of the Express Schema assosiated with the XML Configuration to explore.

xmlConfigurationName

The name of the XML Configuration. This is the string specified by the <configuration id=". . . tag in the XML Configuration.

xmlConfigurationId

Variable that will receive the instanceId that uniquely identifies the XML configuration in the EDMdatabase.

xmlConfigurationString

Variable that will receive the address of an allocated string containing the XML configuration.

nameSpace

Variable that will receive the address of an allocated string containing the optional namespace string associated with the XML configuration. This is the namespace of the elements contained in the UOS element of the generated XML.

nameSpaceAlias

Variable that will receive the address of an allocated string containing the optional alias for the <nameSpace>.

xmlSchemaURL

Variable that will receive the address of an allocated string containing the optional XML Schema URL.

edmiInvocationId

Currently unused.

Returns:
A completion code of datatype EdmiError is the returned function value. The completion code has the following values:
Completion code = 0 : Operation successfully performed.
Completion code != 0: Error in operation. Completion code is an _EDMinterface_ error code. Use edmiGetErrorText to get the error text corresponding to the error code.
Example:
int i;
EdmiError rstat;
SdaiServerContext myContext;
SdaiInstance *pConfigIds, configId;
SdaiString *pConfigNames, configString;
SdaiInteger nConfig;
SdaiString nameSpace, nameSpaceAlias, xmlSchemaURL;
 
/* Create Server Context */
rstat = edmiDefineServerContext("MyContext",
"Johnny", "Supervisor", "cf37ftr", 
"TCP", "9090", "MyServerHost", 
NULL, NULL, NULL, NULL, NULL, &myContext); 
/* Get all xml configurations */
rstat = edmiRemoteListXMLConfigurations(myContext,"IFC2X2_FINAL",
&pConfigIds, &pConfigNames, &nConfig, NULL); 
 
/* Delete them one by one */
for (i=0; i<nConfig; i++) {
/* First, get the configuration info */
rstat = edmiRemoteGetXMLConfiguration(myContext,  
"IFC2X2_FINAL", pConfigNames[i], 
&configId, &configString, &nameSpace, 
&nameSpaceAlias, &xmlSchemaURL, NULL); 
printf("\nDeleting Configuration %s", nameSpaceAlias); 
/* Then, delete it */ 
rstat = edmiRemoteDeleteXMLConfiguration(myContext, "IFC2X2_FINAL", 
pConfigNames[i], NULL); 
}
. . .

  • No labels