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

NameData TypeValue
DescriptionstringHelpService 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.
UMLPackagePathstringCIM::System::Help
Versionstring2.9.0

Class Properties

Local Class Properties

NameData TypeDefault ValueQualifiers
NameData TypeValue
OtherDeliveryOptionDescriptionstring
DescriptionstringDescribes the nature of the delivery method when DeliveryOptions = "Other" is specified.
ModelCorrespondencestringCIM_HelpService.DeliveryOptions
OtherDocumentFormatDescriptionstring
DescriptionstringDescribes the format of the document when DocumentFormat= "Other" is specified.
ModelCorrespondencestringCIM_HelpService.DocumentFormat
DeliveryOptionsuint16[]
DescriptionstringDefines 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.
ModelCorrespondencestringCIM_HelpService.OtherDeliveryOptionDescription, CIM_HelpServiceAvailableToFile
ValueMapstring1, 2, 3, 4, 5, 6
ValuesstringOther, File Contents, File Pointer, Associated File, URL, Program
DocumentDescriptionsstring[]
ArrayTypestringIndexed
DescriptionstringList of descriptions for the corresponding documents.
ModelCorrespondencestringCIM_HelpService.DocumentsAvailable, CIM_HelpService.DocumentFormat
DocumentFormatuint16[]
ArrayTypestringIndexed
DescriptionstringList of document formats for the corresponding documents.
ModelCorrespondencestringCIM_HelpService.OtherDocumentFormatDescription, CIM_HelpService.DocumentDescriptions, CIM_HelpService.DocumentsAvailable
ValueMapstring0, 1, 2, 3, 4, 5, 6
ValuesstringUnknown, Other, XML, HTML, Binary, Executable, .hlp
DocumentsAvailablestring[]
ArrayTypestringIndexed
DescriptionstringList of all of the document names/ids that are available via this help service and NOT exposed by the HelpServiceAvailableToFile association.
ModelCorrespondencestringCIM_HelpService.DocumentDescriptions, CIM_HelpService.DocumentFormat

Inherited Properties

NameData Type
Captionstring
CommunicationStatusuint16
CreationClassNamestring
Descriptionstring
DetailedStatusuint16
ElementNamestring
EnabledDefaultuint16
EnabledStateuint16
Generationuint64
HealthStateuint16
InstallDatedatetime
InstanceIDstring
LoSIDstring
LoSOrgIDstring
Namestring
OperatingStatusuint16
OtherEnabledStatestring
PrimaryOwnerContactstring
PrimaryOwnerNamestring
PrimaryStatusuint16
RequestedStateuint16
Startedboolean
StartModestring
Statusstring
SystemCreationClassNamestring
SystemNamestring
TimeOfLastStateChangedatetime
TransitioningToStateuint16
AvailableRequestedStatesuint16[]
OperationalStatusuint16[]
StatusDescriptionsstring[]

Class Methods

Inherited Class Methods

NameReturn Type
ChangeAffectedElementsAssignedSequenceuint32
RequestStateChangeuint32
StartServiceuint32
StopServiceuint32