ISimilarityTraitsTable::BeginDump method

Retrieves similarity data from the similarity traits table.

Syntax

HRESULT BeginDump(
  ISimilarityTableDumpState **similarityTableDumpState
);

Parameters

similarityTableDumpState

An optional pointer to a location that will receive the returned ISimilarityTableDumpState interface pointer. The caller must release this interface when it is no longer needed.

Return Value

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Remarks

The BeginDump method is used for debugging and garbage collection. It returns an interface pointer to an iterator object that allows the application to efficiently dump all of the entries in the similarity traits table.

Requirements

   
Windows version Windows Vista Windows Server 2008
Target Platform Windows
Header msrdc.h
DLL MsRdc.dll

See Also

ISimilarityTraitsTable