Function Return Types
Each function of crossAPI SI returns an object of the type Result.
Result is a container for three variables:
An integer that contains a specific error code in case of an error and 0 if no error has occurred.
A string that contains a description of the error code in case of an error.
If no error has occurred, this object contains the data returned by the function. More detailed information is available under the item "return value/success" in the descriptions of individual functions. The data type for the interpretation of these variables is given in square brackets in each case.
The descriptions under the item return value/success for each of the functions always refer to the data member of the result container if no error has occurred. The values under return value/error always refer to the error code member of the result container in case of an error. In single function descriptions, you will only find a purely numeric value.
for all functions
crossAPI SI is not connected to the Across Server.
User does not exist.
Unable to create security token.
The assigned security token is either invalid or expired.
The SQL query is invalid. This can either mean that it is syntactically incorrect or that it is writing.
Unable to execute SQL query.
The user is not in the crossAPI group.
The server has given an incorrect answer.
Unable to send message.
The security token could not be returned because crossAPI has not been started.
Unable to create relation.
Unable to create project.
Relation does not exist.
Subject does not exist.
Language does not exist.
Document does not exist.
Job does not exist.
Unable to create job.
Project does not exist.
One or more invalid parameters have been assigned to the function. An example of this is a NULL pointer in C++ when a string is expected.
Job has been canceled.
crossSPI has not been initialized. Details available in crossAPI.log. There is most probably an incompatibility in a DSE*.dll file.
This document format is not supported. Across checks this according to the document extension and not to the content. When a file is checked in or updated, Across first checks whether the document extension is supported and only then if the file is present at the given location.
Workflow does not exist.
Failed to assign workflow to document. A possible reason for this is that the workflow has already been assigned to the document.
Unable to assign user to document.
Task template does not exist.
Document template does not exist.
Cannot generate report.
Unable to delete project. More detailed information can be found in the error description.
Unable to delete document. More detailed information can be found in the error description.
Unable to move project to archive. More detailed information can be found in the error description.
Unable to delete relation. More detailed information can be found in the error description.
Unable to create subject. More detailed information can be found in the error description.
Unable to update document. More detailed information can be found in the error description.
Unable to carry out pre-translation. More detailed information can be found in the error description.
Unable to copy project. More detailed information can be found in the error description.
Unable to carry out relay assignment. More detailed information can be found in the error description.
Unable to rename project. More detailed information can be found in the error description.
Unable to rename document. More detailed information can be found in the error description.
The paragraph state does not exist.
Unable to set paragraph state. More detailed information can be found in the error description.
The job has not yet been completed.
Unable to assign the subject to the project. More detailed information can be found in the error description.
Unable to assign the relation to the project. More detailed information can be found in the error description.
Unable to read license key.
Unable to find license key.
The license key is invalid.
The user group does not exist.
Unable to create user.
Unable to remove user.
Unable to generate crossWAN packages.
Task does not exist.
Unable to export crossWAN packages.
Unable to import crossWAN packages.
Document type is not supported.
Unable to add comment to project.
Unable to add comment to relation.
Unable to set properties of relation.
Unable to add comment to document.
Unable to add comment to language.
Unable to add comment to user.
Unable to create license.
Unable to delete license.
Unable to assign license to user.
Unable to unassign license from user.
Unable to set license data.
Unable to save softkey.
The license already exists.
Cannot open file.
File not found.
Cannot remove file.
Cannot add attachment.
Cannot set project ID.
Cannot import exchange data.
Cannot export exchange data.
Cannot load comments.
The crossGrid Server does not exist.
crossGrid package does not exist.
Cannot create crossGrid package.
Cannot get product version.
Cannot export crossGrid classic package.
Cannot import crossGrid classic package.
Cannot adjust DB.
Cannot set project to finished.
Exchange database (CWU/CRU) migration is not supported.
Job already finished.
Canceling is not supported for the job.
Task cannot be finished. More detailed information can be found in the error description.
Check-in job failed.
Check-out job failed.
crossTank job failed.
Project job failed.
crossGrid job failed.
Cannot create file.
Cannot save document settings.
Cannot load document settings.
Cannot load XML content.
Cannot set user properties.
Cannot retrieve CWU tasks.
Cannot export project.
Cannot import project.
The project does not have an external ID.
External project ID is not set.
Cannot add rating.
Rating already exists.
Rating does not exist.
crossGrid user cannot be edited.
Cannot revoke the task.
Document cannot be finished.
Document cannot be set to unfinished.
Is not ready to be finished.
Language already exists for this document.
Cannot add language.
Cannot remove language.
The language is involved in crossGrid process and cannot be edited or deleted.
Cannot remove rating.
Cannot switch license status.
The user must be an offline user.
Cannot change settings.
Assign job failed.
Cannot apply profile.
Cannot create crossWAN/crossGrid session.
Cannot upload server task.
Cannot download server task.
Cannot remove comment.
Comment not found.
Cannot set finish date.
Cannot set deadline.
The attachment does not exist.
Cannot load attachment.
Cannot remove attachment.
User does not have the permission.
Project settings do not exist.
crossTank/crossTerm package does not exist.
Cannot import crossTank/crossTerm package.
Cannot create project settings.
Cannot load statistics.
Cannot create group.
Language already exists in the system.
Cannot store finished translation.
The Server Context does not exist.
Cannot remove crossTank/crossTerm package.
The task is not assigned.
Cannot load profile.
Cannot set project to released state.
Wrong task type.
Cannot remove subject.
Cannot change user password.
The reporting template does not exist.
Cannot load reporting templates.
Cannot compare files.
Wrong document version number.
Cannot remove document version.
Cannot activate document version.
Cannot set project description.
Invalid username or password.
License does not exist or does not match the master license.
Plugin does not exist.
Attribute does not exist.
Attribute value does not exist.
Cannot add the attribute.
Cannot activate project.
Cannot deactivate project.
Cannot activate all projects.
Cannot deactivate all projects.
File is empty.
The profile does not exist.
The document is not ready because it is being checked in.
Cannot remove attributes.
Requested position is larger than the size of the file.
Error during file operations.
crossTerm job failed.
Cannot add user to group.
Cannot remove user from group.
The instance does not exist.
Cannot get instance.
Document manager job failed.
Task manager job failed.
Project cannot be unfinished.
Language cannot be finished.
Language cannot be unfinished.
Task cannot be unfinished.
Cannot save project settings.
Cannot load project settings.
The crossGrid packaging template does not exist.
The crossWAN packaging template does not exist.
The template cannot be applied.
Cannot remove the crossGrid package.
Cannot close or open the crossGrid package for assignments.
You do not have a license for XLIFF import/export.
Given MT engine is disabled
MT engine does not contain any language configurations
Language configuration with given language pair does not exist
Cannot remove/create document partitions.
The QM check could not be applied because the document does not support it.
QM check failed.
Cannot release bizmodel locks.
Cannot confirm task.
Cannot unconfirm task.
Group cannot be assigned.
Language manager job failed.
Report does not exist.
Cannot get crossGrid packages.
The task has never been finished.
Partitioning is not allowed for source document editing.
Workflow with possibility of source document editing cannot be assigned to partitioned document.
Some tasks are not assigned to offline users.
Some tasks are assigned to different users.
Document was checked-in with a higher version of Across. Check-out and preview are not possible in current version.
Cannot set the document description.
Cannot set progress for non external editing task.
Cannot set progress for task.
The language content cannot be changed.
Cannot reset paragraph states for the task.
Cannot set start date.
Partitioning of tasks is not allowed by the Master Server.
The package cannot be exported because its build is not up to date. Rebuild the package prior to export.
The function is not supported.
Could not mark all comments as resolved.
The operation is rejected.
The login exceeds the maximum number of 100 characters.
The password exceeds the maximum number of 100 characters.
The specified documents have different workflows. The EDR can only handle documents with the same workflow.
You do not have a license for advanced reports.
Unable to evaluate source language for relay translation because relay tasks have different source languages.
The paragraph state is not involved in the workflow.
The paragraph state is not involved in the task.
The language cannot be loaded.
Document extension is not found.
Cannot set project settings.
Incorrect workflow for unsupported document.