Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Code Block
languagecpp
themeConfluence
EdmiError edmiRemoteStopBackup(SdaiServerContext serverContextId,  
                               SdaiOptions       options,       
                               SdaiInvocationId  *edmiInvocationId);

This function stops a backup task.

...

This function is legal for superuser only.

...

Arguments

...

TypeNameComment
SdaiServerContext

serverContextId

A superuser context identification, from edmiDefineServerContext

SdaiOptions

options

See description of available options below.

SdaiInvocationId

*edmiInvocationId

Not yet used. When the <edmiInvocationId> is specified unequal NULL, the actual operation will be asynchronous and a handle (identifier) of the call will be returned in the <edmiInvocationId> argument.
This handle can be used in later operations for requesting the status (waiting, running, finished ..) and the result of the actual operation.

Option: Description:

Return Value

...

Insert excerpt
US:_r_EDMInterface
US:_r_EDMInterface
nopaneltrue

 

Options

...

  

OptionComment
TERMINATE_ACTIVE_BACKUPWhen this option is selected, the backup process is stopped even if the backup thread is active doing backup. If not selected, an ongoing backup is not interrupted

 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:
EdmiError rstat, error;
SdaiServerContext superContextId;
SdaiOptions options = 0;
 
/* Create Server Context */
rstat =

Example

...

 

Code Block
languagecpp
 EdmiError rstat, error;
 SdaiServerContext superContextId;
 SdaiOptions options = 0;
  
 /* Create Server Context */
 rstat = edmiDefineServerContext("SuperContext",

...


 "superuser", "", "super123",

...

 
 "TCP", "9090", "MyServerHost",

...

 
 NULL, NULL, NULL, NULL, NULL, &superContextId);

...

 
  
 /* Stop active backup (after it is completed) */

...


 if (rstat = edmiRemoteStopBackup(superContextId, options, NULL) {

...


 printf("\nError %d in edmiRemoteStopBackup: %s", rstat,

...

 
 edmiGetErrorText(rstat));

...

 
 goto error;

...

 
 }
 ...

 

See also

Filter by label (Content by label)
showLabelsfalse
showSpacefalse
cqllabel = "model" and parent = "6062220"