Contact
Newsletter
Schedule Consultation

LanguageJobManager

  • Unless stated otherwise, all objects are available in the following Across versions:
  • 5.7
  • 6.0
  • 6.3
  • 7.0
Tip

Function-specific return values are listed with each function.

For more information on return values and a complete list of error codes, see Function Return Types.

Function
Description
Cancels the specified job. The function only works for jobs created from LanguageJobManager functions.
Exports a target language together with its source language to an XLIFF file.
Returns the progress of a job. The function only works for jobs created from LanguageJobManager functions.
Returns the result of a finished job. The function only works for jobs created from LanguageJobManager functions.
Returns the status of a job. The function only works for jobs created from LanguageJobManager functions.

LanguageJobManager.CancelJob

Cancels the specified job. The function only works for jobs created from LanguageJobManager functions.

Parameters

 
Type
Name
Description
1
string
ST
A security token for use in other crossAPI SI functions.
2
string
JobGuid
The GUID of the job.

Return Values

Result
Type/Value
Interpretation
Success
Is always empty.
Error
17
Job does not exist.
Error
87
Job already finished.
Error
88
Canceling is not supported for the job.

LanguageJobManager.ExportLanguageToXliff

Exports a target language together with its source language to an XLIFF file.

Parameters

 
Type
Name
Description
1
string
ST
A security token for use in other crossAPI SI functions.
2
string
DocumentGuid
The GUID of the document.
3
int
LanguageLcid
The LCID of the language.
For further information, see LCIDs.
4
string
OutputFileName
The name of the output file. You have to enter a path.

Return Values

Result
Type/Value
Interpretation
Success
string
The GUID of the job.
Error
15
Language does not exist.
Error
16
Document does not exist.
Error
18
Unable to create job.
Error
202
You do not have a license for XLIFF import/export.
Tip

Progress queries can be carried out via GetJobProgress. Status queries can be carried out via the GetJobStatus function.

LanguageJobManager.GetJobProgress

Returns the progress of a job. The function only works for jobs created from LanguageJobManager functions.

Parameters

 
Type
Name
Description
1
string
ST
A security token for use in other crossAPI SI functions.
2
string
JobGuid
The GUID of the job.

Return Values

Result
Type/Value
Interpretation
Success
int
The progress of the job in percent.
Error
17
Job does not exist.
Error
21
Job has been canceled.
Tip

Other return values are possible. They depend on the executed job and mean the job itself failed.

Attention

Do not use this method to find out whether a job is finished or not. A progress of 100 does not necessarily mean that the job is finished already. Use GetJobStatus instead.

LanguageJobManager.GetJobResult

Returns the result of a finished job. The function only works for jobs created from LanguageJobManager functions.

Parameters

 
Type
Name
Description
1
string
ST
A security token for use in other crossAPI SI functions.
2
string
JobGuid
The GUID of the job.

Return Values

Result
Type/Value
Interpretation
Success
int
The progress of the job in percent.
Error
17
Job does not exist.
Error
21
Job has been canceled.
Error
43
The job has not yet been completed.
Tip

Other return values are possible. They depend on the executed job and mean the job itself failed.

LanguageJobManager.GetJobStatus

Returns the status of a job. The function only works for jobs created from LanguageJobManager functions.

Parameters

 
Type
Name
Description
1
string
ST
A security token for use in other crossAPI SI functions.
2
string
JobGuid
The GUID of the job.

Return Values

Result
Type/Value
Interpretation
Success
int
The status of the job.
  • The following values are possible:
  • 0 - in progress
  • 1 - finished successfully
  • 2 - finished with errors
Error
17
Job does not exist.