DfsrIdRecordInfo class

  • Article

This class provides access to ID Table records. The ID Table has a record for each file and folder known to DFSR. In addition, it keeps records of the deleted content.

Syntax

[Dynamic, Provider("DfsrMonitorProv")]
class DfsrIdRecordInfo : CIM_LogicalElement
{
  string       Caption;
  string       Description;
  datetime REF InstallDate;
  string       Name;
  string       Status;
  string       Uid;
  uint8        Flags;
  uint32       Attributes;
  string       GVsn;
  string       Usn;
  string       ParentUid;
  uint64       Fid;
  string       Volume;
  string       Fence;
  datetime     Clock;
  datetime     CreateTime;
  datetime     UpdateTime;
  string       FileHash;
  string       FileName;
  string       FullPathName;
  uint32       Index;
  string       ReplicatedFolderGuid;
};

Members

The DfsrIdRecordInfo class has these types of members:

Methods

The DfsrIdRecordInfo class has these methods.

Method Description
GetFullFilePath Retrieves the complete path to the file or folder.

Properties

The DfsrIdRecordInfo class has these properties.

Attributes

Data type: uint32

Access type: Read-only

Qualifiers: DisplayName ("Attributes")

The file or folder attributes. For a list of values, see the GetFileAttributes function.

Caption

Data type: string

Access type: Read-only

Qualifiers: MaxLen (64)

A short textual description of the object.

This property is inherited from CIM_ManagedSystemElement.

Clock

Data type: datetime

Access type: Read-only

Qualifiers: DisplayName ("Clock")

The logical clock value assigned to the file or folder.

CreateTime

Data type: datetime

Access type: Read-only

Qualifiers: DisplayName ("Create Time")

The creation time stamp of the file or folder. This is the time at which the resource first appears in the replication group.

Description

Data type: string

Access type: Read-only

A textual description of the object.

This property is inherited from CIM_ManagedSystemElement.

Fence

Data type: string

Access type: Read-only

Qualifiers: DisplayName ("Fence")

The fence value associated with the file. This property can be one of the following values.

Unfence (0)

This file or folder will lose all conflicts.

Initial Sync (1)

Initial fence value for non-primary member.

Initial Primary (2)

Initial fence value for primary member.

Default (3)

Default fencing value.

Fence (4)

Fence with current time stamp.

Fid

Data type: uint64

Access type: Read-only

Qualifiers: DisplayName ("File ID")

The file reference number. On NTFS, each file is assigned an identifier which is unique on the volume; it can be used to open a handle to the file.

FileHash

Data type: string

Access type: Read-only

Qualifiers: DisplayName ("File Hash")

A hash value for the file content.

FileName

Data type: string

Access type: Read-only

Qualifiers: DisplayName ("Relative Name")

The name of the file or folder.

Flags

Data type: uint8

Access type: Read-only

Qualifiers: DisplayName ("Flags")

A combination of flags for present, authoritative, and file type flags.

PRESENT_FLAG (0x1)

The resource is not a tombstone; it is available on the computer.

NAME_CONFLICT_FLAG (0x2)

The tombstone was generated because of a name conflict.

This flag is meaningful only for tombstones.

UID_VISIBLE_FLAG (0x4)

The ID record has already been sent out to other partners; therefore, other partners are aware of this resource.

JOURNAL_WRAP_FLAG (0x10)

The volume has had a journal wrap and the resource has not been checked to determine if there is any change by the journal wrap recovery process.

PENDING_TOMBSTONE_FLAG (0x20)

The ID record is in the process of being tombstoned (or deleted.)

FullPathName

Data type: string

Access type: Read-only

Qualifiers: DisplayName ("Full Path Name")

The complete path to the file or folder.

Windows Vista and Windows Server 2008: This property is not supported until Windows Server 2008 R2.

GVsn

Data type: string

Access type: Read-only

Qualifiers: DisplayName ("Global Version")

The global version of the resource (file or folder). The format of this string is {DatabaseGUID}-VersionNumber, where DatabaseGUID is the GUID of the DFSR database and VersionNumber is an integer value assigned to each resource that increases when the resource is modified. Because the database GUID uniquely identifies the last computer that the resource was modified on, the GVsn property uniquely identifies a particular version of the resource.

Index

Data type: uint32

Access type: Read-only

Qualifiers: DisplayName ("Record Index")

The run-time index of the record. This value is used to partition the result of a large query.

InstallDate

Data type: datetime

Access type: Read-only

Indicates when the object was installed. Lack of a value does not indicate that the object is not installed.

This property is inherited from CIM_ManagedSystemElement.

Name

Data type: string

Access type: Read-only

Label by which the object is known. When subclassed, this property can be overridden to be a key property.

This property is inherited from CIM_ManagedSystemElement.

ParentUid

Data type: string

Access type: Read-only

Qualifiers: DisplayName ("Parent GUID")

The unique identifier of the parent folder.

ReplicatedFolderGuid

Data type: string

Access type: Read-only

Qualifiers: DisplayName ("Replicated Folder GUID"), MaxLen (36), MinLen (36)

The unique identifier of the replicated folder.

Status

Data type: string

Access type: Read-only

String that indicates the current status of the object. Operational and non-operational status can be defined. Operational status can include "OK", "Degraded", and "Pred Fail". "Pred Fail" indicates that an element is functioning properly, but is predicting a failure (for example, a SMART-enabled hard disk drive).

Non-operational status can include "Error", "Starting", "Stopping", and "Service". "Service" can apply during disk mirror-resilvering, reloading a user permissions list, or other administrative work. Not all such work is online, but the managed element is neither "OK" nor in one of the other states. This property is inherited from CIM_ManagedSystemElement.

Values include the following:

OK ("OK")

Error ("Error")

Degraded ("Degraded")

Unknown ("Unknown")

Pred Fail ("Pred Fail")

Starting ("Starting")

Stopping ("Stopping")

Service ("Service")

Stressed ("Stressed")

NonRecover ("NonRecover")

No Contact ("No Contact")

Lost Comm ("Lost Comm")

Uid

Data type: string

Access type: Read-only

Qualifiers: Key, DisplayName ("File or Folder GUID-Version Pair")

The unique identifier of the resource (file or folder). The format of this string is {DatabaseGUID}-VersionNumber, where DatabaseGUID is the GUID of the DFSR database and VersionNumber is an integer value assigned to each resource when it is created. Because the database GUID uniquely identifies the computer that the resource was created on, the Uid property uniquely identifies the resource.

UpdateTime

Data type: datetime

Access type: Read-only

Qualifiers: DisplayName ("Update Time")

The last time DFSR updated the record in response to a change in the resource.

Usn

Data type: string

Access type: Read-only

Qualifiers: DisplayName ("USN")

The USN (Update Sequence Number) at the time the resource is updated.

Volume

Data type: string

Access type: Read-only

Qualifiers: DisplayName ("Volume")

The volume where the file or folder is located. The volume format is either \\.\C: or \\?\volume{GUID}.

Requirements
Minimum supported client
 Windows Vista
Minimum supported server
 Windows Server 2008
End of client support
 Windows Vista
Namespace
 Root\MicrosoftDfs
MOF
DfsRProvs.mof
DLL
DfsRWmiV2.dll

See also

CIM_LogicalElement

DFSR WMI Classes