BESAPI.FixletMessage

FixletMessage Methods Description
HRESULT SetAppName (
      BSTR appName
);
 Sets the Application Name string that you use to specify the registry key for the BESAPI. Default is 'BESAPI'.
HRESULT SetDSN (
      BSTR dsn
);
 Sets the name of the ODBC DSN to use when you connect to the database. Default is 'BES_bfenterprise'.
HRESULT Load (
      long siteID, 
      long FixletID, 
      BSTR dbUserName, 
      BSTR password
);
 Connects to the database with the specified username and password. Queries the database for the data of the Fixlet with the specified FixletID contained in the Fixlet site that is identified by the specified siteID. The properties of the FixletMessage object are set with the data read from the database.
HRESULT Delete (
      BSTR dbUserName, 
      BSTR password
);
 Connects to the database with the specified username and password. Deletes this Fixlet, analysis, task, or computer group, and propagates the action site. This method fails if the Load method is not used to load the object.
HRESULT Activate (
      BSTR dbUserName, 
      BSTR password
);
 Connects to the database with the specified username and password. Activates this analysis and propagates the action site. This method fails if the Load method is not used to load the object, or if the object is not an analysis.
HRESULT Deactivate (
      BSTR dbUserName, 
      BSTR password
);
 Connects to the database with the specified username and password. Stops this analysis and propagates the action site. This method fails if the Load method is not used to load the object, or if the object is not an analysis.
FixletMessage Properties Description
HRESULT SiteID (
      [out, retval] long *pVal
);
 The database ID number of the site that contains the loaded Fixlet. Not set until after Load succeeds.
HRESULT FixletID (
      [out, retval] long *pVal
);
 The database ID number of the loaded Fixlet. Not set until after Load succeeds.
HRESULT SiteName (
      [out, retval] long *pVal
);
 The name of the site that contains the loaded Fixlet. Not set until after Load succeeds.
HRESULT SiteDisplayName( 
    [out, retval] BSTR *pVal 
);
 Version 7.1 introduced a new feature where content can rename a site, such that the site name in all the console and Web Reports UI is shown with the new name. To maintain compatibility with an earlier version, the SiteName property still returns the old site name, while this method returns the new site display name.
HRESULT SiteURL (
      [out, retval] long *pVal
);
 The gather URL of the site that contains the loaded Fixlet. Not set until after Load succeeds.
HRESULT Name (
      [out, retval] BSTR *pVal
);
 The name of the loaded Fixlet. Not set until after Load succeeds.
HRESULT Relevance (
      [out, retval] BSTR *pVal
);
 The relevance expression, including parent relevance that defines when the problem identified by this Fixlet affects a client. Not set until after Load succeeds.
HRESULT ActionScript (
      long whichAction, 
      [out, retval] BSTR *pVal
);
 The action script which corrects the problem that is identified by this Fixlet. Because the Fixlet might provide more than one corrective action, you must specify the whichAction parameter. Usually the whichAction parameter is 1. Not set until after Load succeeds.
HRESULT ActionScriptMIMEType (
      long whichAction, 
      [out, retval] BSTR *pVal
);
 The MIME type of the action script which corrects the problem that is identified by this Fixlet. Because the Fixlet might provide more than one corrective action, you must specify the whichAction parameter. Usually the whichAction parameter is 1. Not set until after Load succeeds.
HRESULT ActionScriptTypeName (
      long whichAction, 
      [out, retval] BSTR *pVal
);
 The friendly name of the MIME type of the action script which corrects the problem that is identified by this Fixlet. Because the Fixlet might provide more than one corrective action, you must specify the whichAction parameter. Usually the whichAction parameter is 1. Not set until after Load succeeds.
HRESULT HTML (
      [out, retval] BSTR *pVal
);
 The HTML code for the body of the Fixlet which describes the problem and offers links to the corrective actions. This HTML code might reference image files from the site. Those references are relative, and can be resolved if you set the BASE property of the HTML document to the path to the site's data directory. Not set until after Load succeeds.
HRESULT IsTask (
   [out, retval] BOOL *pVal
);
 True if the Fixlet is a task message. Not set until after Load succeeds.
HRESULT IsAnalysis (
      [out, retval] BOOL *pVal
);
 True if the Fixlet is an analysis. Not set until after Load succeeds.
HRESULT IsPlainFixlet (
      [out, retval] BOOL *pVal
);
 True if the Fixlet is neither a task, analysis, baseline nor computer group. Not set until after Load succeeds.
HRESULT IsBaseline (
      [out, retval] BOOL *pVal
);
 True if the Fixlet is a baseline. Not set until after Load succeeds.
HRESULT DownloadSize (
      [out, retval] UINT *pVal
);
 The size of the download for this Fixlet, in bytes. Not set until after Load succeeds.
HRESULT Source (
      [out, retval] BSTR *pVal
);
 A string that describes the source of this Fixlet (for example, Microsoft). Not set until after Load succeeds.
HRESULT SourceID (
      [out, retval] BSTR *pVal
);
 A string that describes an identifier that is specified by the source of the Fixlet (for example Microsoft KB number). Not set until after Load succeeds.
HRESULT SourceSeverity (
      [out, retval] BSTR *pVal
);
 A string that describes the severity rating of the Fixlet as determined by the source. Not set until after Load succeeds.
HRESULT SourceReleaseDate (
      [out, retval] BSTR *pVal
);
 A string indicating when the source released the information. Not set until after Load succeeds.
HRESULT Category (
      [out, retval] BSTR *pVal
);
 A string that describes the category of this Fixlet as specified by the Fixlet author. Not set until after Load succeeds.
HRESULT Message (
      [out, retval] BSTR *pVal
);
 A string that contains the text message that is specified when this Fixlet was created (applies only to custom Fixlets). Not set until after Load succeeds.
HRESULT IsDeleted (
      [out, retval] BOOL *pVal
);
 True if this Fixlet is deleted (applies only to custom Fixlets). Not set until after Load succeeds.
HRESULT PropertyIDSet (
      [out, retval] BSTR *pVal
);
 A string that contains the list of database IDs of the properties that refer to the properties contained in this analysis. The IDs are separated by tabs. This property is set only for analyses. Not set until after Load succeeds.
HRESULT IsGloballyActivated (
      [out, retval] BOOL *pVal
);
 True if this Fixlet is an analysis and is activated by a Master Operator. Not set until after Load succeeds.
HRESULT IsGloballyActivated (
      [out, retval] BOOL *pVal
);
 True if this Fixlet is an analysis and is activated by a Master Operator. Not set until after Load succeeds.
HRESULT IsLocallyActivated (
      [out, retval] BOOL *pVal
);
 True if this Fixlet is an analysis and is activated by a Non-Master Operator. Not set until after Load succeeds.
HRESULT CanActivate (
      [out, retval] BOOL *pVal
);
 True if this Fixlet is an analysis and can be activated by the current user (the user which was used to Load this Fixlet). Not set until after Load succeeds.
HRESULT CanDeactivate (
      [out, retval] BOOL *pVal
);
 True if this Fixlet is an analysis and can be stopped by the current user (the user which was used to Load this Fixlet). Not set until after Load succeeds.
HRESULT ActionXML (
  long whichAction,
  SAFEARRAY(byte) settingsXML, 
  [out, retval] IXMLDOMDocument
    **actionXML
);
 Returns an importable XML document that represents an action that is taken from this Fixlet, task or baseline. Specify which action with the whichAction parameter. The settingsXML parameter is the bytes of an XML document that specifies the various settings in an action.
HRESULT XML (
  [out, retval] IXMLDOMDocument
    **xml
);
 Returns an importable XML document that represents this Fixlet object.
HRESULT DiagnosticMessage (
      [out, retval] BSTR *pVal
);
 If a method fails, this property returns a string that contains a diagnostic message.
HRESULT StatusMessage (
      [out, retval] BSTR *pVal
);
 Returns a string that describes the status of the current operation (for example propagation).
HRESULT CurrentFIPSMode( 
    BSTR username, 
    BSTR password, 
    [out, retval] BOOL* pVal );
 Retrieves the masthead from the database and returns true if FIPS mode cryptography is enabled in the masthead.