BESAPI.RetrievedProperty

RetrievedProperty Methods Description
HRESULT SetAppName (
      BSTR appName
);
 Sets the Application Name string that is used 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 connecting to the database. Default is 'BES_bfenterprise'.
HRESULT Create (
      BSTR name, 
      BSTR relevance, 
      UINT delaySeconds, 
      BSTR dbUserName, 
      BSTR password
);
 Creates a new retrieved property with the specified name, relevance, and evaluation period. Use the username and password to propagate a new version of the action site. The ID property is set to the database ID of the newly created retrieved property. Note that this function fails if a retrieved property with the same name already exists.
HRESULT Modify (
      long ID, 
      BSTR name, 
      BSTR relevance, 
      BSTR dbUserName, 
      BSTR password
);
 Modifies the existing retrieved property with the specified database ID to have the specified name, relevance and evaluation period. Use the username and password to propagate a new version of the action site. Note that this function fails if the name is changed and a retrieved property with the same name already exists.
HRESULT Delete (
      long ID, 
      BSTR dbUserName, 
      BSTR password
);
 Deletes the existing retrieved property with the specified database ID, and uses the username and password to propagate a new version of the action site.
HRESULT Load (
      long ID, 
      BSTR dbUserName, 
      BSTR password
);
 Connects to the database with the specified username and password, and sets the ID, name, and relevance properties with the values stored in the database for the existing retrieved property with the specified database ID.
RetrievedProperty Properties Description
HRESULT ID (
      [out, retval] long *pVal
);
 The database ID number of the retrieved property. Not set until after either Load, Modify, Delete, or Create has succeeded.
HRESULT Name (
      [out, retval] BSTR *pVal
);
 The name of the retrieved property. Not set until after Load, Modify or Create has succeeded.
HRESULT Relevance (
      [out, retval] BSTR *pVal
);
 The relevance expression that defines the retrieved property. Not set until after Load, Modify, or Create has succeeded.
HRESULT DelaySeconds (
      [out, retval] UINT *pVal
);
 The evaluation period of this retrieved property in seconds (0 means ‘every report’). Not set until after Load, Modify, Delete, or Create has succeeded.
HRESULT IsCustom (
      [out, retval] BOOL *pVal
);
 True if the property is a custom property. Not set until after Load, Modify, Delete, or Create has succeeded.
HRESULT IsReserved (
      [out, retval] BOOL *pVal
);
 True if the property is a reserved property. Not set until after Load, Modify, Delete, or Create has succeeded.
HRESULT IsDefault (
      [out, retval] BOOL *pVal
);
 True if the property is a predefined property. Not set until after Load, Modify, Delete, or Create has succeeded.
HRESULT IsPropertyOverride (
      [out, retval] BOOL *pVal
);
 True if the property is a reference to a property defined in an analysis. The evaluation period of this object overrides the evaluation period specified in the analysis. Not set until after Load, Modify, Delete, or Create has succeeded.
HRESULT SourceSiteID (
      [out, retval] UINT *pVal
);
 If the property is a reference to a property defined in an analysis, then this is the SiteID of the site which contains the analysis. Not set until after Load, Modify, Delete, or Create has succeeded.
HRESULT SourceFixletID (
      [out, retval] UINT *pVal
);
 If the property is a reference to a property defined in an analysis, then this is the FixletID of the analysis. Not set until after Load, Modify, Delete, or Create has succeeded.
HRESULT SourcePropertyID (
      [out, retval] UINT *pVal
);
 If the property is a reference to a property defined in an analysis, then this is the ID of the property withing that analysis. Not set until after Load, Modify, Delete, or Create has succeeded.
HRESULT SourceName (
      [out, retval] BSTR *pVal
);
 If the property is a reference to a property defined in an analysis, then this is the original name of the property in the analysis. Not set until after Load, Modify, Delete, or Create has succeeded.
HRESULT SourceRelevance (
      [out, retval] BSTR *pVal
);
 If the property is a reference to a property defined in an analysis, then this is the original relevance of the property in the analysis. Not set until after Load, Modify, Delete, or Create has succeeded.
HRESULT SourceDelaySeconds (
      [out, retval] BSTR *pVal
);
 If the property is a reference to a property defined in an analysis, then this is the original evaluation period for the property in the analysis. Not set until after Load, Modify, Delete, or Create has succeeded.
HRESULT DiagnosticMessage (
      [out, retval] BSTR *pVal
);
 If a method fails, this property returns a string containing a diagnostic message.
HRESULT StatusMessage (
      [out, retval] BSTR *pVal
);
 Returns a string describing the status of the current operation (such as 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.