Class IconEnvironmentDataBlock

The IconEnvironmentDataBlock structure specifies the path to an icon. The path is encoded using environment variables, which makes it possible to find the icon across machines where the locations vary but are expressed using environment variables.

Inheritance

object

Structure

ExtraDataBlock

IconEnvironmentDataBlock

Inherited Members

ExtraDataBlock.ValidateHeaderBlockSignature(ref byte[])

ExtraDataBlock.Validate(ref byte[], bool)

Structure.Errors

Structure.ValidateInputDataSize(int)

Structure.ValidateHeaderBlockSize(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 IconEnvironmentDataBlock : ExtraDataBlock

Constructors

IconEnvironmentDataBlock()

Constructor

Declaration

public IconEnvironmentDataBlock()

IconEnvironmentDataBlock(string)

Constructor

Declaration

public IconEnvironmentDataBlock(string Target)

Parameters

Type	Name	Description
string	Target	The path that is constructed with environment variables

Properties

BlockSignature

BlockSignature (4 bytes): A 32-bit, unsigned integer that specifies the signature of the IconEnvironmentDataBlock extra data section. This value MUST be 0xA0000007.

Declaration

public override BlockSignature BlockSignature { get; }

Property Value

Type	Description
BlockSignature

Overrides

ExtraDataBlock.BlockSignature

BlockSize

BlockSize (4 bytes): A 32-bit, unsigned integer that specifies the size of the IconEnvironmentDataBlock structure. This value MUST be 0x00000314.

Declaration

public override uint BlockSize { get; }

Property Value

Type	Description
uint

Overrides

ExtraDataBlock.BlockSize

MinimumBlockSize

MinimumBlockSize (4 bytes): A 32-bit, unsigned integer that specifies the minimum size of the IconEnvironmentDataBlock structure. This value MUST be 0x00000314

Declaration

public override uint MinimumBlockSize { get; }

Property Value

Type	Description
uint

Overrides

Structure.MinimumBlockSize

TargetAnsi

TargetAnsi (260 bytes): A NULL-terminated string, defined by the system default code page, which specifies a path that is constructed with environment variables.

Declaration

public string TargetAnsi { get; set; }

Property Value

Type	Description
string

TargetUnicode

TargetUnicode (520 bytes): An optional, NULL-terminated, Unicode string that specifies a path that is constructed with environment variables.

Declaration

public string TargetUnicode { get; set; }

Property Value

Type	Description
string

Methods

FromByteArray(byte[])

Create an IconEnvironmentDataBlock from a given byte array

Declaration

public static IconEnvironmentDataBlock FromByteArray(byte[] ba)

Parameters

Type	Name	Description
byte[]	ba	The byte array

Returns

Type	Description
IconEnvironmentDataBlock	An IconEnvironmentDataBlock object

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()

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

ExtraDataBlock.ToString()