Share via

3.1.4.21 OpenWorkbookForEditing

  • Article

This operation is used to create a new edit session, giving access to a workbook on the protocol server.

The following is the WSDL port type specification of the OpenWorkbookForEditing WSDL operation.

 <wsdl:operation name="OpenWorkbookForEditing" xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/">
   <wsdl:input message="tns:OpenWorkbookForEditingSoapIn"/>
   <wsdl:output message="tns:OpenWorkbookForEditingSoapOut"/>
 </wsdl:operation>

The protocol client sends an OpenWorkbookForEditingSoapIn request message, and the protocol server responds with an OpenWorkbookForEditingSoapOut response message, as follows:

  1. The workbook file, specified by workbookPath, is specified as follows:

    1. It SHOULD be in a format specified by [MS-XLSB], [ISO/IEC29500-1:2011], [MS-OFFMACRO2], or [ODF], but MAY be in any other format.

    2. If it is in the [ISO/IEC29500-1:2011] format:

      1. It MAY<18> contain any valid SpreadsheetML records in that format.

      2. If an odcFile attribute of a connection element ([ISO/IEC29500-1:2011], Part 1, Section 18.13.1) is present, it SHOULD be the path of a file in the format specified by [MS-ODCFF].

      3. If a connection attribute of dbPr element ([ISO/IEC29500-1:2011], Part 1, Section 18.13.3) is present, it SHOULD be in the format specified by [MS-ODBCSTR] or [MS-OLEDBSTR].

    3. If it is in the [MS-XLSB] format:

      1. It MAY<19> contain any valid records in that format.

      2. If a brtBeginExternalConnection record is present and it has the stConnectionFile field present, the stConnectionFile SHOULD be the path of a file in the format specified by [MS-ODCFF].

      3. If a BrtBeginECDbProps record is present, its stConn field SHOULD be in the format specified by [MS-ODBCSTR] or [MS-OLEDBSTR].

    4. If a file in [MS-ODCFF] is referenced by the workbook file:

      1. SourceFile element of OfficeDataConnection ([MS-ODCFF] section 2.7.1.1) MUST NOT be present.

      2. Parameter elements of CT_Connection ([MS-ODCFF] section 2.2.1) MUST be ignored.

  2. If the language represented by uiCultureName is unsupported on the protocol server, the protocol server MAY<20> fall back to some other supported language. uiCultureName MAY<21> be empty, in which case the determination of which language to default to is protocol-server-implementation specific.

  3. If the language represented by dataCultureName is unsupported on the protocol server, the protocol server MAY<22> fall back to some other supported language. dataCultureName MAY<23>  be empty, in which case the determination of which language to default to is protocol-server-implementation specific.

  4. If the operation succeeds, the protocol server MUST return the session identifier of the newly created session (2) in the response message, to be used in any future operations in the newly created session (2).

  5. If there was an application error on the protocol server during the operation, the protocol server MUST return a SOAP fault response, which SHOULD contain one of the following subcodes or any other subcodes specified in section 2.2.9.2, but MAY instead contain any subcode specified in section 2.2.9.1 or any other subcode.

    Subcode

    FileOpenNotFound

    FileOpenAccessDenied

    FileCorrupt

    GenericFileOpenError