• Show convenient version of this site
  • Deutsch
  • English
Contact
Newsletter
  • Products
    • ALS
      • Across Language Server
        • Translation Management
        • Terminology Management
        • Translation Memory
      • Editions
      • Interfaces
    • ATE
      • Across Translator Edition
      • Editions
      • Download
      • Across Account
    • Elanion
      • Overview
      • Login
  • Solutions
    • Customers
      • Enterprises
      • Language Service Providers
      • Translators
    • Industries
      • E-Commerce & Trade
      • Pharmaceuticals & medicine
      • IT & Software
    • Departments
      • Marketing & E-Commerce
      • Technical Documentation
      • Software User Interfaces
  • Services
    • Hosting
    • Training
    • Consulting
  • Partners
    • Language Service Providers
    • Universities
  • Company
    • Across Systems
    • News
    • Events
    • Career
    • Contact
  • Knowledge
    • Blog
    • Video Library
    • Case Studies
    • White Papers
    • Fact Sheets
    • File Formats
    • Expert Features
  • Support
    • New Functions
    • Online Help
    • FAQ
    • Support Request
    • Updates
Schedule Consultation
  • Online-Help
  • SDK
  • APIs
  • crossAPI SI
  • List of Objects in crossAPI SI
  • FileManager
  • General Information
    • Connectors
    • LCIDs
    • GUIDs
    • Paragraph states and flags
    • crossTerm Web
    • crossTransform
      • crossTransform - examples
  • Connecting Third-party Systems
    • crossConnect for content systems
      • Requirements
      • Configuration
        • Configuring the connector
        • Job configuration
        • Testing crossConnect
      • Troubleshooting
    • crossConnect for External Editing
      • Purpose and usage
        • Use case - Machine translation
        • Use Case - Review and QA
        • Use case - Machine review
      • Requirements
      • Implementation
        • Across XLIFF format
          • Across-specific Extensions
          • <xliff> Element Attributes
          • <file> Element Extensions
          • <trans-unit> Element Extension
          • Paragraph States
          • Paragraph State Flags
          • <source> and <target> Element Content
          • <bpt> Element Attributes
          • <ph> Element Attributes
          • <x> Element Attributes
          • Across-specific Properties
          • Analysis Results
          • Sample Files
          • Across XLIFF - import, export and segmentation
          • Context information
          • Exporting best matches in Across XLIFF
          • Hyperlinks to XLIFF
        • Secure file handling with C#
        • Secure file handling with JAVA
        • Workflow and vendor configuration
          • Adding workflows to crossAutomate Host Manager
          • Adjusting preset watchfolders
          • The filter rules
          • External editing workflows
        • Sample code - Integrated solution
    • Generic File Connector
      • Process Overview
      • Exchange Folder Structure
      • Package Format
        • Control File
  • Display Texts
    • Solution approaches
    • The Across solution in detail
    • Requirements
    • Integration
    • The display text format
      • Line height vs. line spacing
      • DT-XML format structure
        • DT-XML - Main elements
        • Children of paragraphStyles and characterStyles
        • Children of the sizeInfos element
        • Children of the paragraph element
        • DT-XML v5 example
        • DT-XML v4 example
    • The display text package
      • Creating a display text package
  • APIs
    • APIs - Technology
    • crossTank API v1
      • Requirements
      • Testing the crossTank API installation
      • OData-URLs in Chrome
      • Example
    • crossTank API v2
      • Requirements
      • QuickStart
        • Searching for Translations
        • Creating Translations
      • crossTank API v2 Overview
        • Finding Translations
        • Creating Translations
        • Translation Properties
        • Formatting and Auto-Adjustment of Formatting and Numbers
      • C# Example
    • crossTerm API v1
      • Scenarios of use
        • Example - usage information
        • Example - finding terms
      • Requirements
      • Special Controllers
      • OData-URLs in Chrome
      • crossTerm API with C#
      • crossTerm API with Java
      • crossTerm API with JavaScript
    • crossTerm API v2
      • Requirements
      • QuickStart
        • Authentication Basics
        • First Request Examples
      • crossTerm API v2 Example in C#
        • Used Functions
      • crossTank API, crossTerm API v2 - Authentication
      • crossTerm API v2 - Examples of Use
        • Finding Terms of Entry
        • Searching Terminology via API
    • crossAPI SI
      • Requirements
      • Function Return Types
      • crossAPI SI and Java
        • Example: hot integration
        • Executing the hot integration example
      • List of Objects in crossAPI SI
        • AssignManager
        • Authorization
        • CheckInManager
        • CheckOutManager
        • CrossTankManager
        • CrossTermManager
        • DocumentManager
        • FileManager
        • LanguageJobManager
        • LanguageManager
        • LicenseManager
        • Message
        • ObjectManager - Overview
          • Part 1
          • Part 2
          • Part 3
        • ReportManager
          • ID values for analysis and analysis-result
        • ProjectManager - Overview
          • Part 1
          • Part 2
          • Attribute Information
        • SqlQuery
        • SystemManager
        • TaskManager
        • WanGridManager - Overview
          • Part 1
          • Part 2
      • Sample - transferring checkout files via FileManager
      • Sample - VBS
    • Text Preprocessing API
      • Introduction
      • How to browse the API
      • Sentence splitting
      • Abbreviations

FileManager

  • 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
FileManager.AppendToFileStream
Appends binary data at the end of a file stream.
FileManager.CreateFileStream
Creates a file stream on the server.
FileManager.GetFileFromServer
Returns the contents of the specified file.
FileManager.GetFileSize
Returns the contents of the specified file.
FileManager.GetGuidOfTemporaryFileName
Returns the GUID of a temporary file on the server. This path can be used for example by CheckOutManager.CreateCheckOutJob.
FileManager.GetPathToFile
Returns the path that corresponds to the supplied FileGUID. This path is most likely not accessible from the caller and can therefore be used only for passing it to functions that require a path.
FileManager.ReadFromFileStream
Reads binary data from a file stream.
FileManager.RemoveFileFromServer
Removes a file from the server that has been sent to it or that has been created previously.
FileManager.SendFileToServer
Sends a file to the crossAPI SI server. The file is then locally stored and can be used in subsequent calls to any function that requires a path to a file.
FileManager.WriteToFileStream
Writes binary data into a file stream.

FileManager.AppendToFileStream

Appends binary data at the end of a file stream.

Parameters

 
Type
Name
Description
1
string
ST
A security token for use in other crossAPI SI functions.
2
string
FileGUID
The GUID of the file stream.
3
object
BinaryData
The data to write in the file.

Return Values

Result
Type/Value
Interpretation
Success
Is always empty.
Error
70
Cannot open file.
Error
71
File not found.

FileManager.CreateFileStream

Creates a file stream on the server.

Parameters

 
Type
Name
Description
1
string
ST
A security token for use in other crossAPI SI functions.
2
string
FileName
The name of the file.

Return Values

Result
Type/Value
Interpretation
Success
string
Returns the GUID of the file.
Error
70
Cannot open file.
Attention

This function creates a temporary file on the server with the provided content. It must be deleted by RemoveFileFromServer after it is no longer needed.

Attention

To safe disk space, any temporary files are cleaned up when the Across Language Server services are restarted.

FileManager.GetFileFromServer

Returns the contents of the specified file.

Parameters

 
Type
Name
Description
1
string
ST
A security token for use in other crossAPI SI functions.
2
string
FileGUID
The GUID of the file which should be returned.

Return Values

Result
Type/Value
Interpretation
Success
object
The binary contents of the file.
Error
70
Cannot open file.
Error
71
File not found.
Error
177
File is empty.
Tip

The file GUID is returned when a file is sent to the server or a temporary file is created on the server. See FileManager.SendFileToServer and FileManager.GetGuidOfTemporaryFileName.

FileManager.GetFileSize

Returns the contents of the specified file.

Parameters

 
Type
Name
Description
1
string
ST
A security token for use in other crossAPI SI functions.
2
string
FileGUID
The GUID of the file which should be returned.

Return Values

Result
Type/Value
Interpretation
Success
long
The length of the file.
Error
70
Cannot open file.
Error
71
File not found.
Tip

The file GUID is returned when a file is sent to the server or a temporary file is created on the server. See FileManager.SendFileToServer and FileManager.GetGuidOfTemporaryFileName.

FileManager.GetGuidOfTemporaryFileName

Returns the GUID of a temporary file on the server. This path can be used for example by CheckOutManager.CreateCheckOutJob.

Parameters

 
Type
Name
Description
1
string
ST
A security token for use in other crossAPI SI functions.
2
string
Extension
The extension that should be used for the file on the server.

Return Values

Result
Type/Value
Interpretation
Success
string
Returns the GUID of the file.
Error
70
Cannot open file.
Attention

This function creates an empty temporary file on the server. It must be deleted by RemoveFileFromServer after it is no longer needed.

FileManager.GetPathToFile

Returns the path that corresponds to the supplied FileGUID. This path is most likely not accessible from the caller and can therefore be used only for passing it to functions that require a path.

Parameters

 
Type
Name
Description
1
string
ST
A security token for use in other crossAPI SI functions.
2
string
FileGUID
The GUID of the file for which the path should be returned.

Return Values

Result
Type/Value
Interpretation
Success
string
The server local path to the file.
Error
71
File not found.
Tip

The file GUID is returned when a file is sent to the server or a temporary file is created on the server. See FileManager.SendFileToServer and FileManager.GetGuidOfTemporaryFileName.

FileManager.ReadFromFileStream

Reads binary data from a file stream.

Parameters

 
Type
Name
Description
1
string
ST
A security token for use in other crossAPI SI functions.
2
string
FileGUID
The GUID of the file stream.
3
long
Position
The start position in the file stream.
4
long
Length
The amount of bytes to read.

Return Values

Result
Type/Value
Interpretation
Success
byte[]
An array of bytes containing the binary data of the file.
Error
70
Cannot open file.
Error
71
File not found.
Error
177
File is empty.
Error
182
Requested position is larger than the size of the file.
Error
183
Error during file operations.

FileManager.RemoveFileFromServer

Removes a file from the server that has been sent to it or that has been created previously.

Parameters

 
Type
Name
Description
1
string
ST
A security token for use in other crossAPI SI functions.
2
string
FileGUID
The GUID of the file which should be removed.

Return Values

Result
Type/Value
Interpretation
Success
Is always empty.
Error
71
File not found.
Tip

The file GUID is returned when a file is sent to the server or a temporary file is created on the server. See FileManager.SendFileToServer and FileManager.GetGuidOfTemporaryFileName.

FileManager.SendFileToServer

Sends a file to the crossAPI SI server. The file is then locally stored and can be used in subsequent calls to any function that requires a path to a file.

Parameters

 
Type
Name
Description
1
string
ST
A security token for use in other crossAPI SI functions.
2
object
BinaryData
The data to write in the file.
3
string
FileName
The name of the file.

Return Values

Result
Type/Value
Interpretation
Success
string
The GUID of the file.
Error
70
Cannot open file.
Attention

This function creates a temporary file on the server with the provided content. It must be deleted by RemoveFileFromServer after it is no longer needed.

Attention

To safe disk space, any temporary files are cleaned up when the Across Language Server services are restarted.

Tip

In order to send bigger files to the server, please change the value of

[HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\MSSOAP\30\SOAPISAP]

MaxPostSize to 0xA00000

(or the entry in the according wow6432node)

Attention

The crossAPI implementation of the SOAP interface was changed with Across v7.0 11332. For newer versions of Across, please check the following section of the web.config for the crossAPI service (C:\Program Files (x86)\Across\crossWeb\web.config):

<bindings>
    <basicHttpBinding>
        <binding maxReceivedMessageSize="1048576" />
    </basicHttpBinding>
    <basicHttpsBinding>
        <binding maxReceivedMessageSize="1048576" />
    </basicHttpsBinding>
</bindings>

The value for maxReceivedMessageSize specifies the maximum allowed size of the SOAP message in bytes. The values must be a positive integer.
(Max. value: 2147483647 - note: this is 1 byte short of 2GB)

Please note that the value is officially a 64-bit integer, but we found that configuring a value higher than the value mentioned before results in an Argument out of range exception when parsing the configuration.

FileManager.WriteToFileStream

Writes binary data into a file stream.

Parameters

 
Type
Name
Description
1
string
ST
A security token for use in other crossAPI SI functions.
2
string
FileGUID
The GUID of the file stream.
3
int
Position
The writing start position in the file stream.
4
object
BinaryData
The data to write in the file.

Return Values

Result
Type/Value
Interpretation
Success
Is always empty.
Error
70
Cannot open file.
Error
71
File not found.
Tip

The data can be given in a byte array.

Attention

Please note that the byte array has to fit the data exactly. All data in the passed array will be written to the file.So filling up the remaining bytes in the buffer with 00 when the buffer is too large for the data will not work. The padding will be written to the file, potentially corrupting it.

Register for our Newsletter now

Our newsletter provides you with exclusive news about the Across Language Server, often even before the official announcement. The newsletter also provides you with early information on events, webinars, and training sessions.

  • Legal Notice
  • GTC
  • Privacy Statement
  • Cookies
  • info@across.net