NodeOPCUA API Documentation
Book
GitHub
Support
Preparing search index...
node-opcua-file-transfer
IClientFile
Interface IClientFile
interface
IClientFile
{
fileHandle
:
number
;
session
:
IBasicSessionAsync
;
close
()
:
Promise
<
void
>
;
getPosition
()
:
Promise
<
UInt64
>
;
open
(
mode
:
OpenFileMode
)
:
Promise
<
number
>
;
openCount
()
:
Promise
<
number
>
;
read
(
bytesToRead
:
number
|
UInt64
|
Int64
,
)
:
Promise
<
Buffer
<
ArrayBufferLike
>
>
;
setPosition
(
position
:
number
|
UInt64
)
:
Promise
<
void
>
;
size
()
:
Promise
<
UInt64
>
;
write
(
data
:
Buffer
)
:
Promise
<
void
>
;
}
Hierarchy (
View Summary
)
IClientFile
IClientFilePriv
Implemented by
ClientFile
Index
Properties
file
Handle
session
Methods
close
get
Position
open
open
Count
read
set
Position
size
write
Properties
file
Handle
fileHandle
:
number
session
session
:
IBasicSessionAsync
Methods
close
close
()
:
Promise
<
void
>
Returns
Promise
<
void
>
get
Position
getPosition
()
:
Promise
<
UInt64
>
Returns
Promise
<
UInt64
>
open
open
(
mode
:
OpenFileMode
)
:
Promise
<
number
>
Parameters
mode
:
OpenFileMode
Returns
Promise
<
number
>
open
Count
openCount
()
:
Promise
<
number
>
Returns
Promise
<
number
>
read
read
(
bytesToRead
:
number
|
UInt64
|
Int64
)
:
Promise
<
Buffer
<
ArrayBufferLike
>
>
Parameters
bytesToRead
:
number
|
UInt64
|
Int64
Returns
Promise
<
Buffer
<
ArrayBufferLike
>
>
set
Position
setPosition
(
position
:
number
|
UInt64
)
:
Promise
<
void
>
Parameters
position
:
number
|
UInt64
Returns
Promise
<
void
>
size
size
()
:
Promise
<
UInt64
>
Returns
Promise
<
UInt64
>
write
write
(
data
:
Buffer
)
:
Promise
<
void
>
Parameters
data
:
Buffer
Returns
Promise
<
void
>
Settings
Member Visibility
Protected
Inherited
Theme
OS
Light
Dark
On This Page
Properties
file
Handle
session
Methods
close
get
Position
open
open
Count
read
set
Position
size
write
Book
GitHub
Support
NodeOPCUA API Documentation
Loading...