cim_messagelog.mof

Pegasus is an open-source implementationof the DMTF CIM and WBEM standards. It is designed to be por

          "output parameter. Otherwise, the value of the parameter is "
          "undefined. \n"
          "\n"
          "IterationIdentifier is defined as an Input/Output method "
          "parameter to allow the Log to embed state information in "
          "the Identifier and potentially let the identifier be "
          "maintained by the using application. \n"
          "\n"
          "The return value from PositionAtRecord should be 0 if the "
          "request was successfully executed, 1 if the request is not "
          "supported and some other value if an error occurred. If the "
          "request is not supported, check the Capabilities array "
          "regarding support for ordinal record number addressing and "
          "backward movement in the Log (values 7 and 4, "
          "respectively). \n"
          "\n"
          "Note: In a subclass, the set of possible return codes could "
          "be described using a ValueMap qualifier on the method. The "
          "strings to which the ValueMap contents are 'translated' may "
          "also be specified in the subclass as a Values array "
          "qualifier.")]
   uint32 PositionAtRecord ( 
         [IN, OUT, Description (
             "An identifier for the iterator.")]
      string IterationIdentifier, 
         [IN, Description (
             "Advancing or retreating the IterationIdentifier is "
             "achieved by setting the MoveAbsolute boolean to FALSE, "
             "and specifying the number of entries to advance or "
             "retreat as positive or negative values in the "
             "RecordNumber parameter. Moving to a specific record "
             "number is accomplished by setting the MoveAbsolute "
             "parameter to TRUE, and placing the record number into "
             "the RecordNumber parameter.")]
      boolean MoveAbsolute, 
         [IN, OUT, Description (
             "The relative or absolute record number.")]
      sint64 RecordNumber); 

      [Description (
          "Requests that the record indicated by the "
          "IterationIdentifier be retrieved from the MessageLog. After "
          "retrieval, the IterationIdentifier may be advanced to the "
          "next record by setting the PositionToNext input parameter "
          "to TRUE. Two output parameters are defined for the method - "
          "RecordData which holds the contents of the Log entry (as an "
          "array of bytes that can be recast to an appropriate "
          "format), and RecordNumber which returns the current record "
          "number addressed via the Iteration Identifier. The "
          "RecordNumber parameter is only defined/valid when the "
          "Capabilities array indicates that ordinal record number "
          "addressing is supported (a value of 7). \n"
          "\n"
          "IterationIdentifier is defined as an Input/Output method "
          "parameter to allow the Log to embed state information in "
          "the Identifier and potentially let the identifier be "
          "maintained by the using application. \n"
          "\n"
          "The return value from GetRecord should be 0 if the request "
          "was successfully executed, 1 if the request is not "
          "supported, and some other value if an error occurred. In a "
          "subclass, the set of possible return codes could be "
          "specified, using a ValueMap qualifier on the method. The "
          "strings to which the ValueMap contents are 'translated' may "
          "also be specified in the subclass as a Values array "
          "qualifier.")]
   uint32 GetRecord ( 
         [IN, OUT, Description (
             "An identifier for the iterator.")]
      string IterationIdentifier, 
         [IN, Description (
             "Boolean indicating that the Iteration Identifier should "
             "be advanced to the next record, after retrieving the "
             "current Log entry.")]
      boolean PositionToNext, 
         [IN ( false ), OUT, Description (
             "The record number.")]
      uint64 RecordNumber, 
         [IN ( false ), OUT, Description (
             "The record data.")]
      uint8 RecordData[]); 

      [Description (
          "Requests that the record indicated by the "
          "IterationIdentifier be deleted from the MessageLog. After "
          "deletion, the Iteration Identifier may be advanced to the "
          "next record by setting the PositionToNext input parameter "
          "to TRUE. If set to FALSE, then the IterationIdentifier will "
          "be positioned at the previous record. Two output parameters "
          "are defined for the method - RecordData which holds the "
          "contents of the deleted Log entry (as an array of bytes "
          "that can be recast to an appropriate format or discarded), "
          "and RecordNumber which returns the current record number "
          "addressed via the IterationIdentifier. The RecordNumber "
          "parameter is only defined/valid when the Capabilities array "
          "indicates that ordinal record number addressing is "
          "supported (a value of 7). \n"
          "\n"
          "IterationIdentifier is defined as an Input/Output method "
          "parameter to allow the Log to embed state information in "
          "the Identifier and potentially let the identifier be "
          "maintained by the using application. \n"
          "\n"
          "The return value from DeleteRecord should be 0 if the "
          "request was successfully executed, 1 if the request is not "
          "supported, and some other value if an error occurred. If "
          "the request is not supported, check the Capabilities array "
          "that a value of 3 (\"Delete Record Supported\") is "
          "specified. \n"
          "\n"
          "Note: In a subclass, the set of possible return codes could "
          "be described using a ValueMap qualifier on the method. The "
          "strings to which the ValueMap contents are 'translated' may "
          "also be specified in the subclass as a Values array "
          "qualifier.")]
   uint32 DeleteRecord ( 
         [IN, OUT, Description (
             "An identifier for the iterator.")]
      string IterationIdentifier, 
         [IN, Description (
             "Boolean that when set to TRUE requests the "
             "IterationIdentifier to be advanced to the next record, "
             "after the current entry is deleted. If set to FALSE, "
             "IterationIdentifier is set to the previous record.")]
      boolean PositionToNext, 
         [IN ( false ), OUT, Description (
             "The record number.")]
      uint64 RecordNumber, 
         [IN ( false ), OUT, Description (
             "The record data.")]
      uint8 RecordData[]); 

      [Description (
          "Requests that a record be inserted at the Log position "
          "indicated by the IterationIdentifier. The entry's data is "
          "provided in the RecordData input parameter. After "
          "insertion, the IterationIdentifier may be advanced to the "
          "next record by setting the PositionToNext input parameter "
          "to TRUE. The output parameter, RecordNumber, returns the "
          "current record number addressed via the "
          "IterationIdentifier. This parameter is only defined/valid "
          "when the Capabilities array indicates that ordinal record "
          "number addressing is supported (a value of 7). \n"
          "\n"
          "IterationIdentifier is defined as an Input/Output method "
          "parameter to allow the Log to embed state information in "
          "the Identifier and potentially let the identifier be "
          "maintained by the using application. \n"
          "\n"
          "The return value from WriteRecord should be 0 if the "
          "request was successfully executed, 1 if the request is not "
          "supported, and some other value if an error occurred. If "
          "the request is not supported, check the Capabilities array "
          "that a value of 2 (\"Write Record Supported\") is "
          "specified. \n"
          "\n"
          "Note: In a subclass, the set of possible return codes could "
          "be described using a ValueMap qualifier on the method. The "
          "strings to which the ValueMap contents are 'translated' may "
          "also be specified in the subclass as a Values array "
          "qualifier.")]
   uint32 WriteRecord ( 
         [IN, OUT, Description (
             "An identifier for the iterator.")]
      string IterationIdentifier, 
         [IN, Description (
             "Boolean indicating that the Iteration Identifier should "
             "be advanced to the next record, after writing the Log "
             "entry.")]
      boolean PositionToNext, 
         [IN, Description (
             "The record data.")]
      uint8 RecordData[], 
         [IN ( false ), OUT, Description (
             "The record number.")]
      uint64 RecordNumber); 

      [Description (
          "Requests that an iteration of the Log, identified by the "
          "IterationIdentifier input parameter, be stopped. The return "
          "value from CancelIteration should be 0 if the request was "
          "successfully executed, 1 if the request is not supported "
          "and some other value if an error occurred. In a subclass, "
          "the set of possible return codes could be specified, using "
          "a ValueMap qualifier on the method. The strings to which "
          "the ValueMap contents are 'translated' may also be "
          "specified in the subclass as a Values array qualifier.")]
   uint32 CancelIteration ( 
         [IN, Description (
             "An identifier for the iterator.")]
      string IterationIdentifier); 

      [Description (
          "Requests that the MessageLog be placed in a frozen state "
          "(\"Freeze\" input parameter = TRUE) or 'unfrozen' (= "
          "FALSE). If frozen, modifications to the Log will not be "
          "allowed. If successful, the Log's IsFrozen boolean property "
          "will be updated to reflect the desired state. \n"
          "\n"
          "The method's return code should be 0 if the request was "
          "successfully executed, 1 if the request is not supported "
          "and some other value if an error occurred. If the request "
          "is not supported, check the Capabilities array that a value "
          "of 5 (\"Freeze Log Supported\") is specified. \n"
          "\n"
          "Note: In a subclass, the set of possible return codes could "
          "be described using a ValueMap qualifier on the method. The "
          "strings to which the ValueMap contents are 'translated' may "
          "also be specified in the subclass as a Values array "
          "qualifier.")]
   uint32 FreezeLog( 
         [IN, Description (
             "If TRUE then freeze the log, if FALSE 'unfreeze' the "
             "log.")]
      boolean Freeze); 

      [Description (
          "Requests that the record indicated by the "
          "IterationIdentifier be flagged as overwriteable. This "
          "method is only supported when the Capabilities array "
          "includes a value of 10, \"Can Flag Records for Overwrite\". "
          "After updating the entry, the IterationIdentifier may be "
          "advanced to the next record by setting the PositionToNext "
          "input parameter to TRUE. One output parameter is defined "
          "for the method RecordNumber. It returns the current record "
          "number addressed via the Iteration Identifier. This "
          "parameter is only defined/valid when the Capabilities array "
          "indicates that ordinal record number addressing is "
          "supported (a value of 7). \n"
          "\n"
          "IterationIdentifier is defined as an Input/Output method "
          "parameter to allow the Log to embed state information in "
          "the Identifier and potentially let the identifier be "
          "maintained by the using application. \n"
          "\n"
          "The return value from FlagRecordForOverwrite should be 0 if "
          "the request was successfully executed, 1 if the request is "
          "not supported, and some other value if an error occurred. "
          "In a subclass, the set of possible return codes could be "
          "specified, using a ValueMap qualifier on the method. The "
          "strings to which the ValueMap contents are 'translated' may "
          "also be specified in the subclass as a Values array "
          "qualifier.")]
   uint32 FlagRecordForOverwrite ( 
         [IN, OUT, Description (
             "An identifier for the iterator.")]
      string IterationIdentifier, 
         [IN, Description (
             "Boolean indicating that the Iteration Identifier should "
             "be advanced to the next record, after updating the "
             "current Log entry.")]
      boolean PositionToNext, 
         [IN ( false ), OUT, Description (
             "The record number.")]
      uint64 RecordNumber); 
};