3.38.4.13 IUpdateSearcher::Online (Opnum 22)

  • Article

The IUpdateSearcher::Online (opnum 22) method sets whether a search performed by using this interface is an online search.

 HRESULT Online(
   [in] VARIANT_BOOL value
 );

value: MUST be set either to VARIANT_TRUE if the search operation can contact the server or to VARIANT_FALSE if it uses local data only.

Return Values: The method MUST return information in an HRESULT data structure. The severity bit in the structure identifies the following conditions:

  • If the severity bit is set to 0, the method completed successfully.

  • If the severity bit is set to 1, the method failed and encountered a fatal error.

If value is neither VARIANT_TRUE nor VARIANT_FALSE, the server MUST return an error.

Exceptions Thrown: No exceptions are thrown beyond those thrown by the underlying RPC protocol [MS-RPCE].

This method SHOULD set the value of the Online ADM element to the value parameter.