Struct SelfUpdateReturnInfo

Namespace

Hi3Helper.Plugin.Core.Update

Assembly

Hi3Helper.Plugin.Core.dll

Returns a struct which contains the information about the update of a plugin.

public struct SelfUpdateReturnInfo : IDisposable

Implements

IDisposable

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Extension Methods

Mem.AsPointer<T>(scoped ref T)

Mem.CopyStructToUnmanaged<T>(scoped ref T)

Constructors

SelfUpdateReturnInfo(SelfUpdateReturnCode)

public SelfUpdateReturnInfo(SelfUpdateReturnCode returnCode)

Parameters

returnCode SelfUpdateReturnCode

Properties

Author

Gets the author name of the upcoming plugin release.

public readonly string? Author { get; }

Property Value

string

CompiledDate

Gets the compilation date of the upcoming plugin release.

public readonly DateTimeOffset? CompiledDate { get; }

Property Value

DateTimeOffset?

CreationDate

Gets the creation date of the upcoming plugin release.

public readonly DateTimeOffset? CreationDate { get; }

Property Value

DateTimeOffset?

Description

Gets the description of the upcoming plugin release.

public readonly string? Description { get; }

Property Value

string

Name

Gets the name of the upcoming plugin release.

public readonly string? Name { get; }

Property Value

string

PluginVersion

Gets the version of the upcoming plugin release.

public readonly GameVersion? PluginVersion { get; }

Property Value

GameVersion?

ReturnCode

Gets the return code of the self-update operation.

public readonly SelfUpdateReturnCode ReturnCode { get; }

Property Value

SelfUpdateReturnCode

StandardVersion

Gets the interface standard version of the upcoming plugin release.

public readonly GameVersion? StandardVersion { get; }

Property Value

GameVersion?

Methods

CreateToNativeMemory(SelfUpdateReturnCode)

Create a struct of this SelfUpdateReturnInfo instance in a native memory but only providing the return code of SelfUpdateReturnCode.

public static nint CreateToNativeMemory(SelfUpdateReturnCode returnCode)

Parameters

returnCode SelfUpdateReturnCode

The return code of the self-update operation.

Returns

nint

A native pointer to the SelfUpdateReturnInfo struct.

CreateToNativeMemory(SelfUpdateReturnCode, string?, string?, string?, GameVersion, GameVersion, DateTimeOffset, DateTimeOffset)

Create a struct of this SelfUpdateReturnInfo instance in a native memory.

public static nint CreateToNativeMemory(SelfUpdateReturnCode returnCode, string? name, string? author, string? description, GameVersion pluginVersion, GameVersion standardVersion, DateTimeOffset creationDate, DateTimeOffset compiledDate)

Parameters

returnCode SelfUpdateReturnCode

The return code of the self-update operation.

name string

Name of the upcoming plugin release provided by manifest.json

author string

The author name of the upcoming plugin release provided by manifest.json

description string

The description of the upcoming plugin release provided by manifest.json

pluginVersion GameVersion

The version of the upcoming plugin release provided by manifest.json

standardVersion GameVersion

The interface standard version of the upcoming plugin release provided by manifest.json

creationDate DateTimeOffset

The creation date of the upcoming plugin release provided by manifest.json

compiledDate DateTimeOffset

The compilation date of the upcoming plugin release provided by manifest.json

Returns

nint

A native pointer to the SelfUpdateReturnInfo struct.

Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

public void Dispose()