Class IDList

The stored IDList structure specifies the format of a persisted item ID list.

Inheritance

object

Structure

IDList

LinkTargetIDList

Inherited Members

Structure.Errors

Structure.ValidateInputDataSize(int)

Structure.ValidateHeaderBlockSize(ref byte[], bool)

Structure.Validate(ref byte[], bool)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Namespace: SharpShellLink.Structures

Assembly: SharpShellLink.dll

Syntax

public class IDList : Structure

Constructors

IDList()

Constructor

Declaration

public IDList()

IDList(List<ItemID>)

Constructor

Declaration

public IDList(List<ItemID> idList)

Parameters

Type	Name	Description
List<ItemID>	idList	An IDList

Fields

TerminalID

TerminalID (2 bytes): A 16-bit, unsigned integer that indicates the end of the item IDs. This value MUST be zero.

Declaration

public readonly byte[] TerminalID

Field Value

Type	Description
byte[]

Properties

DisplayName

Retrieves the display name of an item identified by its IDList.

Declaration

public string DisplayName { get; }

Property Value

Type	Description
string

IDListSize

IDListSize (2 bytes): The size, in bytes, of the IDList field.

Declaration

public ushort IDListSize { get; }

Property Value

Type	Description
ushort

ItemIDList

ItemIDList (variable): An array of zero or more ItemID structures.

Declaration

public List<ItemID> ItemIDList { get; set; }

Property Value

Type	Description
List<ItemID>

MinimumBlockSize

headerBlockSize (4 bytes): A 32-bit, unsigned integer that specifies the size of the ExtraDataBlock structure.

Declaration

public override uint MinimumBlockSize { get; }

Property Value

Type	Description
uint

Overrides

Structure.MinimumBlockSize

Path

Returns the path defined by the item identifier list

Declaration

public string Path { get; set; }

Property Value

Type	Description
string

Methods

GetBytes()

Convert the Structure to a byte array

Declaration

public override byte[] GetBytes()

Returns

Type	Description
byte[]	Byte array representation of the Structure

Overrides

Structure.GetBytes()

GetOffsetByIndex(int)

Gets the offset in bytes into the ItemIDList

Declaration

public uint GetOffsetByIndex(int Index)

Parameters

Type	Name	Description
int	Index	Index into the ItemIDList

Returns

Type	Description
uint

ToString()

Returns a string that represents the current object.

Declaration

public override string ToString()

Returns

Type	Description
string	A string that represents the current object.

Overrides

Structure.ToString()