BPA File System

BPAFileSystem Public interface

Description

Describes methods and properties available on the static instance object BPA.FileSystem.

Diagram

  flowchart LR
  classDef interfaceStyle stroke-dasharray: 5 5;
  classDef abstractStyle stroke-width:4px
  subgraph VGWWCoreIEx
  VGWWCoreIEx.IExBPAFileSystem[[IExBPAFileSystem]]
  class VGWWCoreIEx.IExBPAFileSystem interfaceStyle;
  end

Members

Properties

Public properties

Type	Name	Methods
BPAFileSystemActionType	ActionType Gets the type of action which triggered the watcher.	get
BPAFileSystemChangeType	ChangeType Gets the type of change which triggered the watcher.	get
string	FullPath Gets the full path of the file or folder which triggered the watcher.	get
string	ItemName Gets the item name of the file or folder which triggered the watcher.	get
BPAFileSystemItemType	ItemType Gets the type of item which triggered the watcher.	get
string	LineAdded Gets the line added to the file which triggered the watcher.	get
IMFGSList	LinesAdded Gets an IMFGSList collection of the lines added to the file which triggered the watcher.	get
string	OldFullPath Gets the original full path of the file or folder which triggered the watcher.	get
string	OldItemName Gets the original item name of the file or folder which triggered the watcher.	get

Methods

Public methods

Returns	Name
void	SkipAuto() Flags the watcher to skip any automatic processing after session has ended.

Details

Summary

Describes methods and properties available on the static instance object BPA.FileSystem.

Methods

SkipAuto

public void SkipAuto()

Summary

Flags the watcher to skip any automatic processing after session has ended.

Remarks

This method flags a Line watcher to not perform the automatic update of the persistent file position typically done after the session has ended. This is commonly used to ensure the correct break point is tracked when two or more sequential lines of text are considered a complete “transaction”. Calling this method will cause the value(s) in the LinesAdded collection to be carried over to the next trigger, with the current LineAdded value always being the last element in the collection.

Properties

FullPath

public string FullPath { get; }

Summary

Gets the full path of the file or folder which triggered the watcher.

Remarks

This value is also stored in MFGS.Variables using the name BPA_FullPath.

ItemName

public string ItemName { get; }

Summary

Gets the item name of the file or folder which triggered the watcher.

Remarks

This value is also stored in MFGS.Variables using the name BPA_ItemName.

OldFullPath

public string OldFullPath { get; }

Summary

Gets the original full path of the file or folder which triggered the watcher.

Remarks

Only applicable when ActionType = bpaActionRenamed. This value is also stored in MFGS.Variables using the name BPA_OldFullPath.

OldItemName

public string OldItemName { get; }

Summary

Gets the original item name of the file or folder which triggered the watcher.

Remarks

Only applicable when ActionType = bpaActionRenamed. This value is also stored in MFGS.Variables using the name BPA_OldItemName.

LineAdded

public string LineAdded { get; }

Summary

Gets the line added to the file which triggered the watcher.

Remarks

Only applicable when ActionType = bpaActionLineAdded. This value is also stored in MFGS.Variables using the name BPA_LineAdded.

LinesAdded

public IMFGSList LinesAdded { get; }

Summary

Gets an IMFGSList collection of the lines added to the file which triggered the watcher.

Remarks

This property is typically used in conjunction with the SkipAuto method. The current LineAdded value will always be the last element in the collection (I.e. LineAdded == LinesAdded[LinesAdded.Count - 1]). Only applicable when ActionType = bpaActionLineAdded. The values in this collection are also stored in MFGS.Variables using the name BPA_LinesAdded[index], where ‘index’ is the 1-based integer value. The total number of values in this collection is also stored in MFGS.Variables using the name BPA_LinesAddedCount.

ItemType

public BPAFileSystemItemType ItemType { get; }

Summary

Gets the type of item which triggered the watcher.

Remarks

This value is also stored in MFGS.Variables using the name BPA_ItemType.

ActionType

public BPAFileSystemActionType ActionType { get; }

Summary

Gets the type of action which triggered the watcher.

Remarks

This value is also stored in MFGS.Variables using the name BPA_ActionType.

ChangeType

public BPAFileSystemChangeType ChangeType { get; }

Summary

Gets the type of change which triggered the watcher.

Remarks

Only applicable when ActionType = bpaActionChanged. This value is also stored in MFGS.Variables using the name BPA_ChangeType.

Generated with ModularDoc