3.1.4.10 FindRange
This operation is used to find a string inside a workbook.
-
<wsdl:operation name="FindRange"> <wsdl:input message="FindRangeSoapIn" /> <wsdl:output message="FindRangeSoapOut" /> </wsdl:operation>
The protocol client sends a FindRangeSoapIn request message, and the protocol server responds with a FindRangeSoapOut response message, as follows:
The protocol server searches for the string specified by searchTerm.
The search starts at the adjacent cell of the one specified by searchAfterCell, in the direction specified by searchUp.
If the ObjectName element in the VisibleSheetRangeRequest element in the parameter element is not present, the scope of the search is the worksheet specified by the SheetName element in the searchAfterCell element. Otherwise, the scope of the search is the named object specified by the SheetName element in the searchAfterCell element.
In the event of an application error on the protocol server during this operation, the protocol server MUST return an ExcelServerMessage as specified in section 2.2.9.2. The id element of the ExcelServerMessage MUST be one of the values specified in section 2.2.9.4, and SHOULD<18> be one of the values described in the following table.
Id |
Description |
---|---|
InvalidOrTimedOutSession |
See section 2.2.9.5. |
RetryError |
See section 2.2.9.5. |
OperationCanceled |
See section 2.2.9.5. |
InternalError |
See section 2.2.9.5. |
MultipleRequestsOnSession |
See section 2.2.9.5. |
MaxRequestDurationExceeded |
See section 2.2.9.5. |
NoOccurrencesFound |
The protocol server could not match the string in the searchTerm element to any worksheet cell relevant to the search. |