Help AIW Provider Specification: API Description

The Help AIW Provider provides a means for the application developers to invoke the help application to display a context sensitive help topic. The client applications needs to use the APIs defined by the AIW Framework to use the services of the Help AIW Provider. Consumer applications does not require any additional capabilities to use the Help AIW Provider.

Use cases

The main use cases provided by the Help AIW Provider is the following:

• Providing context sensitive help launch support for the client applications.

API class structure

The Help AIW Provider implements a service command declared by the AIW Criteria API. Clients can access the Help AIW Provider using the AIW Service Handler API. The client application needs to pass the necessary parameters using the AIW Generic Parameter API.

The following command defined by the AIW Criteria API is implemented by the Help AIW Provider.

• KAiwCmdHelp

The implementation ID of the Help AIW Provider is 0x10207465. It can be used to explicitly set the default provider as Help AIW provider by the consumer applications.

The TAiwGenericParam class defined by the AIW Generic Parameter API is used for passing data to the Help AIW Provider.