ShellItemId Class |
A class that represent a Windows Shell's SHITEMID structure
Inheritance HierarchyNamespace: ShellBoost.Core
Assembly: ShellBoost.Core (in ShellBoost.Core.dll) Version: 1.8.3.0
SyntaxC#
public class ShellItemId : IEquatable<ShellItemId>
The ShellItemId type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | ShellItemId |
Initializes a new instance of the ShellItemId class.
|
Properties| Name | Description | |
|---|---|---|
 | Data |
Gets the SHITEMID data.
|
| DebugString |
Gets a string useful for debugging.
|
| IsKnown |
Gets a value indicating whether this instance is known (built by ShellBoost methods) by the current Shell Folder Server.
|
| IsTerminator |
Gets a value indicating whether this instance is the terminator.
|
| Payload |
Gets the payload, which is the Data without the Header.
|
| Size |
Gets the SHITEMID data size.
|
Methods| Name | Description | |
|---|---|---|
 | CheckedSize |
Gets a checked data size.
|
| ComputeHashCode |
Computes the hash code for this instance.
|
 | CopyToPointer |
Allocates a buffer and copies this instance data to it.
|
| Equals(Object) |
Determines whether the specified Object is equal to this instance.
(Overrides ObjectEquals(Object).) |
| Equals(ShellItemId) |
Indicates whether the current object is equal to another object of the same type.
|
| FromData |
Creates an instance of a ShellItemId from a PIDL data.
|
| FromFileSystem(FileSystemInfo) |
Creates an instance of a ShellItemId from a FileSystemInfo instance.
Note the PIDL created is internal to ShellBoost, it cannot be used as a standard Windows Shell PIDL.
|
| FromFileSystem(String, FileAttributes) |
Creates an instance of a ShellItemId from a file system name and attributes.
Note the PIDL created is internal to ShellBoost, it cannot be used as a standard Windows Shell PIDL.
|
| FromPayload(Byte) |
Creates an instance of a ShellItemId from a byte array representing a payload (without a header).
|
| FromPayload(Byte, Int32) |
Creates an instance of a ShellItemId from a byte array representing a payload (without a header).
|
| FromPayload(Byte, Int32, Int32) |
Creates an instance of a ShellItemId from a byte array representing a payload (without a header).
|
| GetHashCode |
Returns a hash code for this instance.
(Overrides ObjectGetHashCode.) |
| GetPayload |
Gets the payload, which is the Data without the Header.
|
| TryGetFileSystemName(String) |
Tries to get a file system name from this instance.
Only supported for file system PIDLs created by ShellBoost, using ShellItemId.FromFileSystem or ShellItem's constructors with FileInfo or DirectoryInfo parameters.
|
| TryGetFileSystemName(String, SFGAO) |
Tries to get a file system name and attributes from this instance.
Only supported for file system PIDLs created by ShellBoost, using ShellItemId.FromFileSystem or ShellItem's constructors with FileInfo or DirectoryInfo parameters.
|
Operators| Name | Description | |
|---|---|---|
 | Equality |
Implements the == operator.
|
| Inequality |
Implements the != operator.
|
Fields| Name | Description | |
|---|---|---|
 | HeaderSize |
The SHITEMID structure header size which is 2 (bytes).
|
| Terminator |
The terminator instance, an array of two zero bytes.
|
See Also