Result of probing one index in EnumerateIndices(). More...
#include <rpcTypes.h>
Collaboration diagram for profinet::rpc::IndexProbeResult:Public Attributes | |
| std::string | status |
| Probe outcome: "readable", "empty", or "error". | |
| std::string | name |
| Human-readable name of the index. | |
| std::size_t | size = 0 |
| Payload size in bytes; valid when Status == "readable". | |
| std::string | error |
| Error message; valid when Status == "error". | |
| std::uint8_t | errorCode1 = 0 |
| PNIOError ErrorCode1, if the error was a PNIOError. | |
| std::uint8_t | errorCode2 = 0 |
| PNIOError ErrorCode2, if the error was a PNIOError. | |
Detailed Description
Result of probing one index in EnumerateIndices().
Definition at line 269 of file rpcTypes.h.
Member Data Documentation
◆ error
| std::string profinet::rpc::IndexProbeResult::error |
Error message; valid when Status == "error".
Definition at line 278 of file rpcTypes.h.
Referenced by profinet::rpc::RPCCon::EnumerateIndices().
◆ errorCode1
| std::uint8_t profinet::rpc::IndexProbeResult::errorCode1 = 0 |
PNIOError ErrorCode1, if the error was a PNIOError.
Definition at line 280 of file rpcTypes.h.
Referenced by profinet::rpc::RPCCon::EnumerateIndices().
◆ errorCode2
| std::uint8_t profinet::rpc::IndexProbeResult::errorCode2 = 0 |
PNIOError ErrorCode2, if the error was a PNIOError.
Definition at line 282 of file rpcTypes.h.
Referenced by profinet::rpc::RPCCon::EnumerateIndices().
◆ name
| std::string profinet::rpc::IndexProbeResult::name |
Human-readable name of the index.
Definition at line 274 of file rpcTypes.h.
Referenced by profinet::rpc::RPCCon::EnumerateIndices().
◆ size
| std::size_t profinet::rpc::IndexProbeResult::size = 0 |
Payload size in bytes; valid when Status == "readable".
Definition at line 276 of file rpcTypes.h.
Referenced by profinet::rpc::RPCCon::EnumerateIndices().
◆ status
| std::string profinet::rpc::IndexProbeResult::status |
Probe outcome: "readable", "empty", or "error".
Definition at line 272 of file rpcTypes.h.
Referenced by profinet::rpc::RPCCon::EnumerateIndices().
The documentation for this struct was generated from the following file:
- include/profinet/rpcTypes.h
