# 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 | Class Origin
--- | --- | ---
Caption | string | CIM_ManagedElement
CommunicationStatus | uint16 | CIM_ManagedSystemElement
CreationClassName | string | CIM_Service
Description | string | CIM_ManagedElement
DetailedStatus | uint16 | CIM_ManagedSystemElement
ElementName | string | CIM_ManagedElement
EnabledDefault | uint16 | CIM_EnabledLogicalElement
EnabledState | uint16 | CIM_EnabledLogicalElement
HealthState | uint16 | CIM_ManagedSystemElement
InstallDate | datetime | CIM_ManagedSystemElement
InstanceID | string | CIM_ManagedElement
Name | string | CIM_Service
OperatingStatus | uint16 | CIM_ManagedSystemElement
OtherEnabledState | string | CIM_EnabledLogicalElement
PrimaryOwnerContact | string | CIM_Service
PrimaryOwnerName | string | CIM_Service
PrimaryStatus | uint16 | CIM_ManagedSystemElement
RequestedState | uint16 | CIM_EnabledLogicalElement
Started | boolean | CIM_Service
StartMode | string | CIM_Service
Status | string | CIM_ManagedSystemElement
SystemCreationClassName | string | CIM_Service
SystemName | string | CIM_Service
TimeOfLastStateChange | datetime | CIM_EnabledLogicalElement
TransitioningToState | uint16 | CIM_EnabledLogicalElement
AvailableRequestedStates | uint16[] | CIM_EnabledLogicalElement
OperationalStatus | uint16[] | CIM_ManagedSystemElement
StatusDescriptions | string[] | CIM_ManagedSystemElement

## Class Methods

### Local Class Methods

#### GetHelp (uint32)

#### Method Qualifiers (GetHelp)

Name | Data Type | Value
--- | --- | ---
Description | string | The GetHelp method produces, as an OUT parameter, a string containing document information as specified by the input parameters. The input parameters are expected to be valid sets of values from the corresponding indexed properties of this class.
ValueMap | string | 0, 1, 2, 3, 4, 5, .., 0x1000, 0x1001, 0x1002..0x7FFF, 0x8000..0xFFFF
Values | string | Document returned with no error, Not Supported, Unspecified Error, Timeout, Failed, Invalid Parameter, DMTF Reserved, Busy, Requested Document not found, Method Reserved, Vendor Reserved

#### Method Parameters (GetHelp)

Name | Type | Qualifiers
--- | --- | ---
Name | Data Type | Value
DocumentInfo | string
Description | string | If RequestedDelivery = File Contents, then the string contains the contents. File Pointer, then the string contains a pointer to the file. File Reference, then the string contains a REF to a CIM_LogicalFile instance. URL, then then the string contains a URL to the help site. Program, then the string is empty; the program was launched.
IN | boolean | false
OUT | boolean | true
Format | uint16
Description | string | The requested document format is passed in. The actual document format is returned.
IN | boolean | true
ModelCorrespondence | string | CIM_HelpService.DocumentFormat
OUT | boolean | true
ValueMap | string | 0, 1, 2, 3, 4, 5, 6
Values | string | Don't Care, Other, XML, HTML, Binary, Executable, .hlp
RequestedDelivery | uint16
Description | string | The requested delivery mechanism.
IN | boolean | true
ModelCorrespondence | string | CIM_HelpService.DeliveryOptions
ValueMap | string | 1, 2, 3, 5, 6
Values | string | Other, File Contents, File Pointer, URL, Program
RequestedDocument | string
Description | string | The name/id of the requested document or the reference to the associated document.
IN | boolean | true
ModelCorrespondence | string | CIM_HelpService.DocumentsAvailable, CIM_HelpServiceAvailableToFile.UserOfService

### Inherited Class Methods

Name | Return Type | Class Origin
--- | --- | ---
RequestStateChange | uint32 | CIM_EnabledLogicalElement
StartService | uint32 | CIM_Service
StopService | uint32 | CIM_Service