IHelpKeywordCollection interface

[This documentation is preliminary and is subject to change.]

Interface for enumerating the collection of IHelpKeyword objects.

Members

The IHelpKeywordCollection interface inherits from the IDispatch interface. IHelpKeywordCollection also has the following types of members:

  • Methods
  • Properties

Methods

The IHelpKeywordCollection interface has the following methods.

Method Description
GetEnumerator

method GetEnumerator-Returns an enumerator that iterates through a collection.

Load

method Load-Loads the keyword index from the provided filename.

MoveNext

method MoveNext-Advances the enumerator to the next element of the collection.

MoveTo

method MoveTo-Sets current element in the collection the specified index.

MoveToKeyword

method MoveToKeyword-Sets current element in the collection the first occurrence of the supplied string.

Reset

method Reset-Sets the enumerator to its initial position, which is before the first element in the collection.

Save

method Save-Saves the keyword index to the provided filename.

 

Properties

The IHelpKeywordCollection interface has the following properties.

Property Access type Description

Count

Read-only

Returns the number of elements in the collection.

Current

Read-only

Gets the current IHelpKeyword element in the collection.

pageSize

Read-only

Returns the page size of the collection.

 

Requirements

Minimum supported client

Windows Developer Preview

Minimum supported server

Windows Server Developer Preview

IDL

Windows.Help.Runtime.idl

 

 

Build date: 9/7/2011