2.2.1 CreateDCInfo

The CreateDCInfo common data type stores the result of a conversion task performed by a server that implements the IDocumentConversionsLauncher interface. The CreateDCInfo common data type is specified by the Microsoft.HtmlTrans.Interface library as follows.

 namespace Microsoft.HtmlTrans
 { 
 class CreateDCInfo
     {
         CreationErrorType m_ce;
         String m_strMainFileName;
         Byte[] m_rgbMainFile;
         String[] m_rgstrSupportingFileNames;
         Byte[][] m_rgrgbSupportingFiles;
         String m_strSupportingFolderName;
         String m_strErrorString;
     }
 }

m_ce: The error type of the conversion task that finished execution.

m_strMainFileName: The file name of the result file. If the conversion task finishes successfully, this member MUST be set to a non-empty value, MUST be 128 or fewer characters in length, and MUST NOT contain any of the characters specified in Section 2.2. If the conversion task was not successful, this member MUST be set to an empty string.

m_rgbMainFile: The result file of the conversion task. This member MUST be non-null if the conversion task finishes successfully and the fReturnFileBits parameter of IDocumentConversionsLauncher.ConvertFile is set to true. Otherwise, this member MUST be set to null.

m_rgstrSupportingFileNames: The filenames of the supporting files. MUST be set to a non-null value if any supporting files are created. Otherwise, this member MUST be set to null. Each string within the array MUST be 128 or fewer characters in length and MUST NOT contain any of the characters specified in Section 2.2.

m_rgrgbSupportingFiles: The supporting files created by the conversion task. The size of the array MUST be identical to that of the m_rgstrSupportingFileNames parameter. The index of a file in this array MUST be the same as the index of the corresponding file name in the m_rgstrSupportingFileNames member. The array MUST be set to null if no supporting files are created. Otherwise, this member MUST be set to a non-null value.

m_strSupportingFolderName: The name of the supporting folder. If any supporting files are created, this member MUST be set to a non-empty value, MUST be 128 or fewer characters in length, and MUST NOT contain any of the characters specified in Section 2.2. Otherwise, this member MUST be set to an empty string value.

m_strErrorString: An implementation-specific description of the actions performed by the conversion application.

If the CreateDCInfo method returns supporting files, the result file MUST reference these files using relative paths under the assumption that the supporting folder appears at the same level in the directory hierarchy as the result file. For example, if the result file needs to reference a supporting file named "a.txt" and the name of the supporting folder is "B" a correct reference is in the form, "B\a.txt".