ObjectLockRequest class | QSYS API Reference Guide
Estimated reading time: 9 minutes
Provides facilities to Allocate and De-Allocate object related.
Namespace: ASNA.QSys.Runtime.JobSupport Assembly: ASNA.QSys.Runtime.dll
Inheritance: Object
Constructors
| Name | Description |
|---|---|
| ObjectLockRequest(AdgConnection) | Initializes a new instance of the ObjectLockRequest. |
ObjectLockRequest(AdgConnection)
Initializes a new instance of the ObjectLockRequest.
ObjectLockRequest(AdgConnection)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| AdgConnection | connection | The connection to the database holding the objects to be allocate. |
Methods
| Signature | Description |
|---|---|
| AddDataArea(String, ShareTypes) | Adds a data area to the list of objects to allocate. |
| AddFile(String, ShareTypes) | Adds a file to the list of objects to allocate. |
| AddLibrary(String, ShareTypes) | Adds a library to the list of objects to allocate. |
| AddMember(String, String, ShareTypes) | Adds a file member to the list of objects to allocate. |
| AllocateDataArea(AdgConnection, String, ShareTypes, WaitOptions, Int16) | Allocates an individual Data Area. |
| AllocateFile(AdgConnection, String, ShareTypes, WaitOptions, Int16) | Allocates an individual File. |
| AllocateLibrary(AdgConnection, String, ShareTypes, WaitOptions, Int16) | Allocates an individual Library. |
| AllocateMember(AdgConnection, String, ShareTypes, WaitOptions, Int16) | Allocates an individual file Member. |
| AllocateObjects(WaitOptions, Int16) | Allocate the objects in the list. |
| DeallocateDataArea(AdgConnection, String, ShareTypes) | Deallocates an individual Data Area. |
| DeallocateFile(AdgConnection, String, ShareTypes) | Deallocates an individual File. |
| DeallocateLibrary(AdgConnection, String, ShareTypes) | Deallocates an individual Library. |
| DeallocateMember(AdgConnection, String, ShareTypes) | Deallocates an individual file Member. |
| DeallocateObjects() | Deallocate all objects held in the list. |
void AddDataArea(string dataAreaPath, ShareTypes shareType)
Adds a data area to the list of objects to allocate.
void AddDataArea(string dataAreaPath, ShareTypes shareType)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| String | dataAreaPath | Path of the data area to include in the allocation list. |
| ShareTypes | shareType | Type of share to request. |
void AddFile(string filePath, ShareTypes shareType)
Adds a file to the list of objects to allocate.
void AddFile(string filePath, ShareTypes shareType)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| String | filePath | Path of the file to include in the allocation list. |
| ShareTypes | shareType | Type of share to request. |
void AddLibrary(string libraryName, ShareTypes shareType)
Adds a library to the list of objects to allocate.
void AddLibrary(string libraryName, ShareTypes shareType)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| String | libraryName | Library to include in the allocation list. |
| ShareTypes | shareType | Type of share to request. |
void AddMember(string filePath, string member, ShareTypes shareType)
Adds a file member to the list of objects to allocate.
void AddMember(string filePath, string member, ShareTypes shareType)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| String | filePath | Path of the member’s parent file. |
| String | member | Name of member to include in the allocation list. |
| ShareTypes | shareType | Type of share to request. |
void AllocateDataArea(AdgConnection connection, string pathName, ShareTypes shareType, WaitOptions waitOption, short waitTime)
Allocates an individual Data Area.
void AllocateDataArea(AdgConnection connection, string pathName, ShareTypes shareType, WaitOptions waitOption, short waitTime)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| AdgConnection | connection | The connection to the database holding the object to be allocate. |
| String | pathName | Path of the data area to allocate. |
| ShareTypes | shareType | Type of share to request. |
| WaitOptions | waitOption | One of enumeration values that specifies how to wait for the object allocation. |
| Int16 | waitTime | Maximum number of seconds to wait for the object to be allocated. |
void AllocateFile(AdgConnection connection, string pathName, ShareTypes shareType, WaitOptions waitOption, short waitTime)
Allocates an individual File.
void AllocateFile(AdgConnection connection, string pathName, ShareTypes shareType, WaitOptions waitOption, short waitTime)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| AdgConnection | connection | The connection to the database holding the object to be allocate. |
| String | pathName | Path of the file to allocate. |
| ShareTypes | shareType | Type of share to request. |
| WaitOptions | waitOption | One of enumeration values that specifies how to wait for the object allocation. |
| Int16 | waitTime | Maximum number of seconds to wait for the object to be allocated. |
void AllocateLibrary(AdgConnection connection, string pathName, ShareTypes shareType, WaitOptions waitOption, short waitTime)
Allocates an individual Library.
void AllocateLibrary(AdgConnection connection, string pathName, ShareTypes shareType, WaitOptions waitOption, short waitTime)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| AdgConnection | connection | The connection to the database holding the object to be allocate. |
| String | pathName | Path of the library to allocate. |
| ShareTypes | shareType | Type of share to request. |
| WaitOptions | waitOption | One of enumeration values that specifies how to wait for the object allocation. |
| Int16 | waitTime | Maximum number of seconds to wait for the object to be allocated. |
void AllocateMember(AdgConnection connection, string pathName, ShareTypes shareType, WaitOptions waitOption, short waitTime)
Allocates an individual file Member.
void AllocateMember(AdgConnection connection, string pathName, ShareTypes shareType, WaitOptions waitOption, short waitTime)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| AdgConnection | connection | The connection to the database holding the object to be allocate. |
| String | pathName | Path of the member (library/file/member) to allocate. |
| ShareTypes | shareType | Type of share to request. |
| WaitOptions | waitOption | One of enumeration values that specifies how to wait for the object allocation. |
| Int16 | waitTime | Maximum number of seconds to wait for the object to be allocated. |
void AllocateObjects(WaitOptions waitOption, short waitTime)
Allocate the objects in the list.
void AllocateObjects(WaitOptions waitOption, short waitTime)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| WaitOptions | waitOption | One of enumeration values that specifies how to wait for each object allocation. |
| Int16 | waitTime | Maximum number of seconds to wait for each object to be allocated. |
void DeallocateDataArea(AdgConnection connection, string pathName, ShareTypes shareType)
Deallocates an individual Data Area.
void DeallocateDataArea(AdgConnection connection, string pathName, ShareTypes shareType)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| AdgConnection | connection | The connection to the database holding the object to be released. |
| String | pathName | Path of the data area to deallocate. |
| ShareTypes | shareType | Type of share used to originally allocate the object. |
void DeallocateFile(AdgConnection connection, string pathName, ShareTypes shareType)
Deallocates an individual File.
void DeallocateFile(AdgConnection connection, string pathName, ShareTypes shareType)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| AdgConnection | connection | The connection to the database holding the object to be released. |
| String | pathName | Path of the file to deallocate. |
| ShareTypes | shareType | Type of share used to originally allocate the object. |
void DeallocateLibrary(AdgConnection connection, string pathName, ShareTypes shareType)
Deallocates an individual Library.
void DeallocateLibrary(AdgConnection connection, string pathName, ShareTypes shareType)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| AdgConnection | connection | The connection to the database holding the object to be released. |
| String | pathName | Path of the library to deallocate. |
| ShareTypes | shareType | Type of share used to originally allocate the object. |
void DeallocateMember(AdgConnection connection, string pathName, ShareTypes shareType)
Deallocates an individual file Member.
void DeallocateMember(AdgConnection connection, string pathName, ShareTypes shareType)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| AdgConnection | connection | The connection to the database holding the object to be released. |
| String | pathName | Path of the member to deallocate. |
| ShareTypes | shareType | Type of share used to originally allocate the object. |
void DeallocateObjects()
Deallocate all objects held in the list.
void DeallocateObjects()