FileOpenAttr class | QSYS API Reference Guide

Estimated reading time: 4 minutes

Represents the attributes for opening a file.

Namespace: ASNA.DataGate.Providers Assembly: ASNA.QSys.DataGate.Client.dll

Inheritance: Object –> Hashtable

Thread Safety

Any public static (Shared) members of this type are safe for multithreaded operations. Any instance members are not guaranteed to be thread safe.

Name	Description
FileOpenAttr()	Initializes a new instance of the FileOpenAttr class.

Initializes a new instance of the FileOpenAttr class.

FileOpenAttr()

Type	Name	Description
Int32	BlockingFactor	Gets or sets the blocking factor for the file to be opened.
Int32	BulkCopyTimeout	The number of seconds to wait for a SQL bulk copy operation tocomplete. If this quantum elapses prior to completion, the SQLprovider may throw an exception. The default value is provider-defined. The provider may define special values as well.For example, this property directly corresponds to theBulkCopyTimeout property of System.Data.SqlClient.SqlBulkCopy,which has a default value of 30 seconds. A value of zero disablesthe timeout function, and the operation waits indefinitely forcompletion.
FileLocks	FileLocks	Gets or sets the file locks for the file to be opened.
Byte[][]	FormatIDs	Gets or sets the format IDs for the file to be opened.
Boolean	InhibitWrite	Gets or sets a value indicating whether writing to the file to be opened is inhibited.
Object	Item	Gets or sets the value associated with the specified key.
Object	Item	Gets or sets the value associated with the specified key.
ServerCursors	ServerCursor	Gets or sets a value indicating whether a server cursor is used for the file to be opened.
ShareTypes	ShareTypes	Gets or sets the share types for the file to be opened.
Int32	WaitForEOF	Gets or sets the number of seconds to wait for the end of file (EOF) to be reached.
Int32	WaitForFile	Gets or sets the number of seconds to wait for the file to be opened.
Int32	WaitForRecord	Gets or sets the number of seconds to wait for the record to be opened.

Signature	Description
Add(String, Object)	Adds an element with the provided key and value to the FileOpenAttr.
ContainsKey(String)	Determines whether the FileOpenAttr contains an element with the specified key.
Remove(String)	Removes the element with the specified key from the FileOpenAttr.
TryGetValue(String, Object&)	Gets the value associated with the specified key.

Adds an element with the provided key and value to the FileOpenAttr.

void Add(string key, object value)

Type	Parameter name	Description
String	key	The object to use as the key of the element to add.
Object	value	The object to use as the value of the element to add.

Determines whether the FileOpenAttr contains an element with the specified key.

bool ContainsKey(string key)

Type	Parameter name	Description
String	key	The key to locate in the FileOpenAttr.

Type	Description
Boolean	true if the FileOpenAttr contains an element with the key; otherwise, false.

Removes the element with the specified key from the FileOpenAttr.

bool Remove(string key)

Type	Parameter name	Description
String	key	The key of the element to remove.

Type	Description
Boolean	true if the element is successfully found and removed; otherwise, false.

Gets the value associated with the specified key.

bool TryGetValue(string key, Object& value)

Type	Parameter name	Description
String	key	The key of the value to get.
Object&	value	When this method returns, contains the value associated with the specified key, if the key is found; otherwise, the default value for the type of the value parameter.

Type	Description
Boolean	true if the FileOpenAttr contains an element with the specified key; otherwise, false.