Edit

Share via

ICommandTree::FindErrorNodes method (cmdtree.h)

  • Article

Note

Indexing Service is no longer supported as of Windows XP and is unavailable for use as of Windows 8. Instead, use Windows Search for client side search and Microsoft Search Server Express for server side search.

The ICommandTree::FindErrorNodes method traverses a command tree and returns an array of nodes with errors in them.

Syntax

HRESULT FindErrorNodes(
  [in]  const DBCOMMANDTREE *pRoot,
  [out] ULONG               *pcErrorNodes,
  [out] DBCOMMANDTREE       ***prgErrorNodes
);

Parameters

[in] pRoot

A pointer to the root of the command tree.

[out] pcErrorNodes

A pointer to memory in which to return the number of nodes containing errors.

[out] prgErrorNodes

A pointer to memory in which to return an array of pointers to nodes that contain errors. The command object allocates memory for this array and returns the address to this memory; the consumer releases this memory with IMalloc::Free when it no longer needs the array. If *pcErrorNodes is 0 on output, the provider does not allocate any memory and thus ensures that *prgErrorNodes is a null pointer on output.

Return value

This method can return one of these values.

Return code Description
S_OK
 The method succeeded.
E_FAIL
 A provider-specific error occurred.
E_INVALIDARG
 pRoots, pcErrorNodes, or prgErrorNodes was a null pointer.
E_OUTOFMEMORY
 The provider was unable to allocate sufficient memory in which to return the array of pointers to nodes containing errors.

Requirements

Requirement Value
Minimum supported client Windows 2000 Professional [desktop apps only]
Minimum supported server Windows 2000 Server [desktop apps only]
Target Platform Windows
Header cmdtree.h

See also

ICommandTree