BESAPI.ActionStopper

ActionStopper 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 StopAction (
      UINT actionID, 
      BSTR dbUserName, 
      BSTR password
);
 Stops the existing action in the database with the specified ID number, and uses the username and password to propagate a new version of the action site.
HRESULT DeleteAction (
      UINT actionID, 
      BSTR dbUserName, 
      BSTR password
);
 Permanently deletes the existing action in the database with the specified ID number, and uses the username and password to propagate a new version of the action site. The action must be stopped or expired. Open actions cannot be deleted.
ActionStopper Properties Description
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 (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.