# Class CIM_HelpService
extends CIM_Service

HelpService provides the ability for a managed element to describe and provide access to its Help information. Support for various delivery mechanisms and data formats can be specified so that the most suitable data representation can be chosen. In adddition, a request can be made to launch a "Help" program, if available.

### Table of Contents
Hierarchy
Direct Known Subclasses
Class Qualifiers
Class Properties
Class Methods

## Class Hierarchy

CIM_ManagedElement
|
+--CIM_ManagedSystemElement
|
+--CIM_LogicalElement
|
+--CIM_EnabledLogicalElement
|
+--CIM_Service
|
+--CIM_HelpService

## Direct Known Subclasses

## Class Qualifiers

Name | Data Type | Value
--- | --- | ---
Description | string | HelpService provides the ability for a managed element to describe and provide access to its Help information. Support for various delivery mechanisms and data formats can be specified so that the most suitable data representation can be chosen. In adddition, a request can be made to launch a "Help" program, if available.
UMLPackagePath | string | CIM::System::Help
Version | string | 2.9.0

## Class Properties

### Local Class Properties

Name | Data Type | Default Value | Qualifiers
--- | --- | --- | ---
Name | Data Type | Value
OtherDeliveryOptionDescription | string |
Description | string | Describes the nature of the delivery method when DeliveryOptions = "Other" is specified.
ModelCorrespondence | string | CIM_HelpService.DeliveryOptions
OtherDocumentFormatDescription | string |
Description | string | Describes the format of the document when DocumentFormat= "Other" is specified.
ModelCorrespondence | string | CIM_HelpService.DocumentFormat
DeliveryOptions | uint16[] |
Description | string | Defines the delivery methods supported by this help service./n "File Contents" indicates that the contents of the Help file is returned by the GetHelp method. "File Pointer" indicates that a fully specified path to the Help file is returned by the GetHelp method. "Associated File" indicates that associations to CIM_LogicalFile instance(s) is available. "URL" indicates that a URL to a website is returned by the GetHelp method. "Program" indicates that a Help program is launched (on the local system) by the GetHelp method.
ModelCorrespondence | string | CIM_HelpService.OtherDeliveryOptionDescription, CIM_HelpServiceAvailableToFile
ValueMap | string | 1, 2, 3, 4, 5, 6
Values | string | Other, File Contents, File Pointer, Associated File, URL, Program
DocumentDescriptions | string[] |
ArrayType | string | Indexed
Description | string | List of descriptions for the corresponding documents.
ModelCorrespondence | string | CIM_HelpService.DocumentsAvailable, CIM_HelpService.DocumentFormat
DocumentFormat | uint16[] |
ArrayType | string | Indexed
Description | string | List of document formats for the corresponding documents.
ModelCorrespondence | string | CIM_HelpService.OtherDocumentFormatDescription, CIM_HelpService.DocumentDescriptions, CIM_HelpService.DocumentsAvailable
ValueMap | string | 0, 1, 2, 3, 4, 5, 6
Values | string | Unknown, Other, XML, HTML, Binary, Executable, .hlp
DocumentsAvailable | string[] |
ArrayType | string | Indexed
Description | string | List of all of the document names/ids that are available via this help service and NOT exposed by the HelpServiceAvailableToFile association.
ModelCorrespondence | string | CIM_HelpService.DocumentDescriptions, CIM_HelpService.DocumentFormat

### Inherited Properties

Name | Data Type
--- | ---
Caption | string
CommunicationStatus | uint16
CreationClassName | string
Description | string
DetailedStatus | uint16
ElementName | string
EnabledDefault | uint16
EnabledState | uint16
Generation | uint64
HealthState | uint16
InstallDate | datetime
InstanceID | string
LoSID | string
LoSOrgID | string
Name | string
OperatingStatus | uint16
OtherEnabledState | string
PrimaryOwnerContact | string
PrimaryOwnerName | string
PrimaryStatus | uint16
RequestedState | uint16
Started | boolean
StartMode | string
Status | string
SystemCreationClassName | string
SystemName | string
TimeOfLastStateChange | datetime
TransitioningToState | uint16
AvailableRequestedStates | uint16[]
OperationalStatus | uint16[]
StatusDescriptions | string[]

## Class Methods

### Inherited Class Methods

Name | Return Type
--- | ---
ChangeAffectedElementsAssignedSequence | uint32
RequestStateChange | uint32
StartService | uint32
StopService | uint32