read_messageT_read_messageReadMessageReadMessageread_message (Operator)
Name
read_messageT_read_messageReadMessageReadMessageread_message — Read a message from a file.
Signature
void ReadMessage(const HTuple& FileName, const HTuple& GenParamName, const HTuple& GenParamValue, HTuple* MessageHandle)
void HMessage::HMessage(const HString& FileName, const HTuple& GenParamName, const HTuple& GenParamValue)
void HMessage::HMessage(const HString& FileName, const HString& GenParamName, const HString& GenParamValue)
void HMessage::HMessage(const char* FileName, const char* GenParamName, const char* GenParamValue)
void HMessage::HMessage(const wchar_t* FileName, const wchar_t* GenParamName, const wchar_t* GenParamValue)
(Windows only)
void HMessage::ReadMessage(const HString& FileName, const HTuple& GenParamName, const HTuple& GenParamValue)
void HMessage::ReadMessage(const HString& FileName, const HString& GenParamName, const HString& GenParamValue)
void HMessage::ReadMessage(const char* FileName, const char* GenParamName, const char* GenParamValue)
void HMessage::ReadMessage(const wchar_t* FileName, const wchar_t* GenParamName, const wchar_t* GenParamValue)
(Windows only)
static void HOperatorSet.ReadMessage(HTuple fileName, HTuple genParamName, HTuple genParamValue, out HTuple messageHandle)
public HMessage(string fileName, HTuple genParamName, HTuple genParamValue)
public HMessage(string fileName, string genParamName, string genParamValue)
void HMessage.ReadMessage(string fileName, HTuple genParamName, HTuple genParamValue)
void HMessage.ReadMessage(string fileName, string genParamName, string genParamValue)
Description
read_messageread_messageReadMessageReadMessageReadMessageread_message reads a message that has been stored with
write_messagewrite_messageWriteMessageWriteMessageWriteMessagewrite_message.
The default HALCON file extension for a message is 'hmsg'.
Execution Information
- Multithreading type: independent (runs in parallel even with exclusive operators).
- Multithreading scope: global (may be called from any thread).
- Processed without parallelization.
This operator returns a handle. Note that the state of an instance of this handle type may be changed by specific operators even though the handle is used as an input parameter by those operators.
Parameters
FileNameFileNameFileNameFileNamefileNamefile_name (input_control) filename.read → HTuplestrHTupleHtuple (string) (string) (HString) (char*)
File name.
File extension: .hmsg
GenParamNameGenParamNameGenParamNameGenParamNamegenParamNamegen_param_name (input_control) attribute.name(-array) → HTupleMaybeSequence[str]HTupleHtuple (string) (string) (HString) (char*)
Name of the generic parameter.
Default value: []
List of values: 'name'"name""name""name""name""name"
GenParamValueGenParamValueGenParamValueGenParamValuegenParamValuegen_param_value (input_control) attribute.name(-array) → HTupleMaybeSequence[Union[int, float, str]]HTupleHtuple (string / integer / real) (string / int / long / double) (HString / Hlong / double) (char* / Hlong / double)
Value of the generic parameter.
Default value: []
MessageHandleMessageHandleMessageHandleMessageHandlemessageHandlemessage_handle (output_control) message → HMessage, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)
Message handle.
Number of elements: MessageHandle == 1
Assertion: MessageHandle != 0
Result
If the parameters are valid, the operator read_messageread_messageReadMessageReadMessageReadMessageread_message returns
the value TRUE. If necessary an exception is raised.
Possible Predecessors
write_messagewrite_messageWriteMessageWriteMessageWriteMessagewrite_message
See also
write_messagewrite_messageWriteMessageWriteMessageWriteMessagewrite_message,
serialize_handleserialize_handleSerializeHandleSerializeHandleSerializeHandleserialize_handle,
deserialize_handledeserialize_handleDeserializeHandleDeserializeHandleDeserializeHandledeserialize_handle
Module
Foundation