int MXCommon__GetConfigurationBackupFile ( void *  _,
struct MXCommon__FileResponse Response 
)
Parameters:
[in] _ : No input parameter
[out] Response 
  • sResponse.iReturnValue : Return value
    • 0 : success
    • -1: system error (see syserrno) (see syserrno)
  • sResponse.syserrno : System-error code. The value of the libc "errno" code, see MXCommon__Strerror().
  • bArray : Array of Bytes of the file
  • ulEOF : End of file flag
Return values:
SOAP_OK SOAP call success
otherwise SOAP protocol error

This function is designed to be called repeatedly until no more data is available. At this point the flag ulEOF is set.

Below is an example in pseudo-C.


int dummy;
struct MXCommon__FileResponse Response;
while(1)
{
if ( MXCommon__GetConfigurationBackupFile(&dummy, &Response) != SOAP_OK)
{
// handle soap error
}
if (Response.iReturnValue)
{
// handle remote error (Response.syserrno contains more information)
}
// do something with the data, for example save it in a file
write(fd, Response.bArray.__ptr, Response.bArray.__size);
// if this is the end of the file, quit the loop
if(Response.ulEOF)
break;
}
*