Class FileNameExtensions
A class to handle file name encoding
Inheritance
Namespace: DocuWare.Platform.ServerClient
Assembly: DocuWare.Platform.ServerClient.dll
Syntax
public static class FileNameExtensions : objectMethods
CreateCheckoutFileName(String, String, Int32)
Creates a name of the checkout file which contains the encoded document address.
Declaration
public static string CreateCheckoutFileName(string fileName, string fileCabinetId, int docId)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | fileName | Name of the file. |
| System.String | fileCabinetId | The file cabinet identifier. |
| System.Int32 | docId | The document identifier. |
Returns
| Type | Description |
|---|---|
| System.String | A file name which contains the address of the document. |
DecodeCheckoutFileName(String, out String, out String, out Int32)
Strips the address of a checked out file from its name.
Declaration
public static void DecodeCheckoutFileName(string encodedName, out string fileName, out string fileCabinetId, out int docId)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | encodedName | Encoded name of the file. |
| System.String | fileName | Name of the file. |
| System.String | fileCabinetId | The file cabinet identifier. |
| System.Int32 | docId | The document identifier. |
MakeFileNameSane(String)
Makes the file name sane.
Declaration
public static string MakeFileNameSane(string fileName)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | fileName | Name of the file. |
Returns
| Type | Description |
|---|---|
| System.String | The file name without not allowed characters. |
Remarks
This function removes any not supported character from a file name.
TryDecodeCheckoutFileName(String, out String, out String, out Int32)
Tries decode the file name of a checkout file.
Declaration
public static bool TryDecodeCheckoutFileName(string encodedName, out string fileName, out string fileCabinetId, out int docId)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | encodedName | Name of the encoded. |
| System.String | fileName | Name of the file. |
| System.String | fileCabinetId | The file cabinet identifier. |
| System.Int32 | docId | The document identifier. |
Returns
| Type | Description |
|---|---|
| System.Boolean |
|