HelpLibraryManagerException Class

This exception class is thrown to report problems with the Help Library Manager operation

Definition

Namespace: SandcastleBuilder.MicrosoftHelpViewer
Assembly: SandcastleBuilder.Utils (in SandcastleBuilder.Utils.dll) Version: 2024.12.21.0

C#View Source Request Example

[SerializableAttribute]
public class HelpLibraryManagerException : Exception

VBView Source Request Example

<SerializableAttribute>
Public Class HelpLibraryManagerException
	Inherits Exception

C++View Source Request Example

[SerializableAttribute]
public ref class HelpLibraryManagerException : public Exception

F#View Source Request Example

[<SerializableAttribute>]
type HelpLibraryManagerException = 
    class
        inherit Exception
    end

Inheritance: Object Exception HelpLibraryManagerException

Constructors

HelpLibraryManagerException(SerializationInfo, StreamingContext)	Initializes a new instance of the Exception class with serialized data.
HelpLibraryManagerException(Version, Int32)	Constructor
HelpLibraryManagerException(Version, Int32, String)	Constructor

Properties

Data	Gets a collection of key/value pairs that provide additional user-defined information about the exception. (Inherited from Exception)
ErrorCode	This read-only property returns the error code
HelpLink	Gets or sets a link to the help file associated with this exception. (Inherited from Exception)
HResult	Gets or sets HRESULT, a coded numerical value that is assigned to a specific exception. (Inherited from Exception)
InnerException	Gets the Exception instance that caused the current exception. (Inherited from Exception)
Message	Gets a message that describes the current exception. (Inherited from Exception)
Source	Gets or sets the name of the application or the object that causes the error. (Inherited from Exception)
StackTrace	Gets a string representation of the immediate frames on the call stack. (Inherited from Exception)
TargetSite	Gets the method that throws the current exception. (Inherited from Exception)
Version	This read-only property returns the help viewer version to which the error code applies

Methods

Equals	Determines whether the specified object is equal to the current object. (Inherited from Object)
Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object)
GetBaseException	When overridden in a derived class, returns the Exception that is the root cause of one or more subsequent exceptions. (Inherited from Exception)
GetHashCode	Serves as the default hash function. (Inherited from Object)
GetObjectData	When overridden in a derived class, sets the SerializationInfo with information about the exception. (Overrides Exception.GetObjectData(SerializationInfo, StreamingContext))
GetType	Gets the runtime type of the current instance. (Inherited from Exception)
MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object)
ToString	Creates and returns a string representation of the current exception. (Inherited from Exception)

Events

SerializeObjectState

Occurs when an exception is serialized to create an exception state object that contains serialized data about the exception.
(Inherited from Exception)

Fields

Canceled	The operation was canceled.
CatalogNotInstalled	The catalog is not installed.
ContentManagementDisabled	Content management has been disabled.
FailOnFetchingContentFromDisk	Failed while fetching content from disk.
FailOnFetchingInstalledBooks	Failed while fetching installed books.
FailOnFetchingOnlineContent	Failed while fetching online content.
FailOnInstall	Failed on install operation.
FailOnMachineLock	The help content store could not be locked for update. This error typically occurs when the content is locked for update by another process.
FailOnMove	Failed on move operation.
FailOnRefresh	Failed on refresh operation.
FailOnSettingLocalStore	The path specified for the /content switch is invalid.
FailOnSilentInstall	The installation of content failed. Detailed information can be found in the event log and in the installation log.
FailOnSilentUninstall	The removal of content failed. Detailed information can be found in the event log and in the installation log.
FailOnUninstall	Failed on uninstall operation.
FailOnUpdate	Failed on update operation.
FailureToElevate	Failed to elevate with administrative privileges.
HelpLibraryManagerAlreadyRunning	The Help Library Manager is already running.
HelpLibraryManagerNotFound	The Help Library Manager was not found.
HV2InvalidCmdArgs	One or more command line arguments was missing or invalid.
HV2NoBooksToInstall	The arguments passed to HLM did not result in content being installed. This can occur when the content is already installed.
InvalidCatalogInfo	Files required to install content for a new product were invalid.
InvalidCmdArgs	One or more command line arguments was missing or invalid.
InvalidHelpLocation	The local content store is in an invalid state. This error occurs when the directory permissions do not allow writing, or a required file is missing from the directory.
LocalStoreNotInitialized	The local store is not initialized.
MissingCatalogInfo	Files required to install content for a new product were not found.
MissingCommandLineArgument	A required command line argument is missing.
MissingOrInvalidAppConfig	The application configuration file for HLM was missing or invalid.
NoBooksToInstall	The arguments passed to HLM did not result in content being installed or removed. This can occur when the content is already installed or has already been removed.
NoBooksToUninstall	The arguments passed to HLM did not result in content being removed. This can occur when the content has already been removed.
NonAdminSetsLocalStoreOnSilentMode	A non-admin user is trying to initialize the store using the /silent switch.
OnlineHelpPreferenceDisabled	Online help preference has been disabled.
Others	An unknown error occurred.
Success	The operation was successful.
UnknownError	An unknown error occurred in the Help Library Manager launcher.
UpdateAlreadyRunning	Another update is already running.

Extension Methods

GetExceptionMessage

This is used to get the message strings from an exception and any of its inner exceptions
(Defined by BuildComponentUtilities)