# EpubReferenceError

Describes why an EPUB URL reference could not be resolved.

Enum 

`OfficeIMO.Epub`

**Namespace**

`OfficeIMO.Epub`

**Assembly**

`OfficeIMO.Epub`

**Source revision**

`ba882f6b0d07` with working tree changes

**Source**

[EpubReferenceError.cs:4](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Epub/EpubReferenceError.cs#L4)

**Base**

`Enum`

**Implements**

`IComparable` `ISpanFormattable` `IFormattable` `IConvertible`

**Modifiers**

sealed

Describes why an EPUB URL reference could not be resolved.

## Inheritance

- Enum
- EpubReferenceError

## Usage

Explore 8 API references to this type

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

### Returned or exposed by 8

- Property [EpubReference.Error](/api/epub/officeimo-epub-epubreference/#property-error)
- Field [EpubReferenceError.ControlCharacter](/api/epub/officeimo-epub-epubreferenceerror/#field-controlcharacter)
- Field [EpubReferenceError.Empty](/api/epub/officeimo-epub-epubreferenceerror/#field-empty)
- Field [EpubReferenceError.EscapesContainer](/api/epub/officeimo-epub-epubreferenceerror/#field-escapescontainer)
- Field [EpubReferenceError.FileUrl](/api/epub/officeimo-epub-epubreferenceerror/#field-fileurl)
- Field [EpubReferenceError.InvalidBasePath](/api/epub/officeimo-epub-epubreferenceerror/#field-invalidbasepath)
- Field [EpubReferenceError.InvalidPath](/api/epub/officeimo-epub-epubreferenceerror/#field-invalidpath)
- Field [EpubReferenceError.None](/api/epub/officeimo-epub-epubreferenceerror/#field-none)

Filter members 

Show inherited

## Inherited Methods

`public int CompareTo(object? target)` [#](#method-compareto-object)

Inherited from Enum

Parameters

**target object? required**

Returns

`int`

`public override bool Equals(object? obj)` [#](#method-equals-object)

Inherited from Enum

Parameters

**obj object? required**

Returns

`bool`

`public override int GetHashCode()` [#](#method-gethashcode)

Inherited from Enum

Returns

`int`

`public Type GetType()` [#](#method-gettype)

Inherited from object

Returns

`Type`

`public TypeCode GetTypeCode()` [#](#method-gettypecode)

Inherited from Enum

Returns

`TypeCode`

`public bool HasFlag(Enum flag)` [#](#method-hasflag-enum)

Inherited from Enum

Parameters

**flag Enum required**

Returns

`bool`

ToString 4 overloads

`public override string ToString()` [#](#method-tostring)

Inherited from Enum

Returns

`string`

`public string ToString(string? format)` [#](#method-tostring-string)

Inherited from Enum

Parameters

**format string? required**

Returns

`string`

`public string ToString(IFormatProvider? provider)` [#](#method-tostring-iformatprovider)

Inherited from Enum

`Obsolete("The provider argument is not used. Use ToString() instead.")`

Parameters

**provider IFormatProvider? required**

Returns

`string`

`public string ToString(string? format, IFormatProvider? provider)` [#](#method-tostring-string-iformatprovider)

Inherited from Enum

`Obsolete("The provider argument is not used. Use ToString(String) instead.")`

Parameters

**format string? required**

**provider IFormatProvider? required**

Returns

`string`

## Values

`public const EpubReferenceError None` [#](#field-none)

[EpubReferenceError.cs:6](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Epub/EpubReferenceError.cs#L6)

The reference resolved successfully.

Value: `0`

`public const EpubReferenceError Empty` [#](#field-empty)

[EpubReferenceError.cs:9](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Epub/EpubReferenceError.cs#L9)

The reference value was empty.

Value: `1`

`public const EpubReferenceError InvalidBasePath` [#](#field-invalidbasepath)

[EpubReferenceError.cs:12](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Epub/EpubReferenceError.cs#L12)

The container base path was not a safe archive path.

Value: `2`

`public const EpubReferenceError ControlCharacter` [#](#field-controlcharacter)

[EpubReferenceError.cs:15](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Epub/EpubReferenceError.cs#L15)

The reference contains a control character.

Value: `3`

`public const EpubReferenceError FileUrl` [#](#field-fileurl)

[EpubReferenceError.cs:18](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Epub/EpubReferenceError.cs#L18)

The reference uses the prohibited file: URL scheme.

Value: `4`

`public const EpubReferenceError InvalidPath` [#](#field-invalidpath)

[EpubReferenceError.cs:21](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Epub/EpubReferenceError.cs#L21)

The reference contains an invalid or ambiguous path encoding.

Value: `5`

`public const EpubReferenceError EscapesContainer` [#](#field-escapescontainer)

[EpubReferenceError.cs:24](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Epub/EpubReferenceError.cs#L24)

The reference attempts to traverse above the EPUB container root.

Value: `6`

<!-- PowerForge markdown artifact sha256:3272412D68A1B8A73A92EBB6A9CA4BE5A2A94D249AA35CE65BB915C5D25BC634 -->
