write_messageT_write_messageWriteMessageWriteMessage (Operator)
Name
write_messageT_write_messageWriteMessageWriteMessage — Write a message to a file.
Signature
void WriteMessage(const HTuple& MessageHandle, const HTuple& FileName, const HTuple& GenParamName, const HTuple& GenParamValue)
void HMessage::WriteMessage(const HString& FileName, const HTuple& GenParamName, const HTuple& GenParamValue) const
void HMessage::WriteMessage(const HString& FileName, const HString& GenParamName, const HString& GenParamValue) const
void HMessage::WriteMessage(const char* FileName, const char* GenParamName, const char* GenParamValue) const
void HMessage::WriteMessage(const wchar_t* FileName, const wchar_t* GenParamName, const wchar_t* GenParamValue) const
(Windows only)
Description
write_messagewrite_messageWriteMessageWriteMessageWriteMessage writes the message denoted by the
MessageHandleMessageHandleMessageHandleMessageHandlemessageHandle to the file given by FileNameFileNameFileNameFileNamefileName.
The default HALCON file extension for a message is 'hmsg'.
If MessageHandleMessageHandleMessageHandleMessageHandlemessageHandle contains a handle that can not be serialized or
that has been freed already, an exception is raised per default.
This behavior is controlled by GenParamNameGenParamNameGenParamNameGenParamNamegenParamName
'raise_error_if_content_not_serializable'"raise_error_if_content_not_serializable""raise_error_if_content_not_serializable""raise_error_if_content_not_serializable""raise_error_if_content_not_serializable", and the corresponding
GenParamValueGenParamValueGenParamValueGenParamValuegenParamValue can take the following values:
- 'true'"true""true""true""true":
The default: Errors are raised and the writing process aborted.
- 'low_level'"low_level""low_level""low_level""low_level":
Only low level errors are raised. Instead of the handle concerned an empty
handle is written in FileNameFileNameFileNameFileNamefileName and the writing
process will be continued. The behavior regarding HALCON low level errors
is determined by do_low_errordo_low_errordo_low_errordo_low_errordoLowError in set_systemset_systemSetSystemSetSystemSetSystem.
- 'false'"false""false""false""false":
The errors are suppressed. Instead of the handle concerned an empty
handle is written in FileNameFileNameFileNameFileNamefileName and the writing
process will be continued.
Execution Information
- Multithreading type: independent (runs in parallel even with exclusive operators).
- Multithreading scope: global (may be called from any thread).
- Processed without parallelization.
Parameters
MessageHandleMessageHandleMessageHandleMessageHandlemessageHandle (input_control) message → HMessage, HTupleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)
Message handle.
Number of elements: MessageHandle == 1
Restriction: MessageHandle != 0
FileNameFileNameFileNameFileNamefileName (input_control) filename.write → HTupleHTupleHtuple (string) (string) (HString) (char*)
File name.
File extension: .hmsg
GenParamNameGenParamNameGenParamNameGenParamNamegenParamName (input_control) attribute.name(-array) → HTupleHTupleHtuple (string) (string) (HString) (char*)
Name of the generic parameter.
Default value: []
List of values: 'raise_error_if_content_not_serializable'"raise_error_if_content_not_serializable""raise_error_if_content_not_serializable""raise_error_if_content_not_serializable""raise_error_if_content_not_serializable"
GenParamValueGenParamValueGenParamValueGenParamValuegenParamValue (input_control) attribute.name(-array) → HTupleHTupleHtuple (string / integer / real) (string / int / long / double) (HString / Hlong / double) (char* / Hlong / double)
Value of the generic parameter.
Default value: []
Suggested values: 'true'"true""true""true""true", 'false'"false""false""false""false", 'low_level'"low_level""low_level""low_level""low_level"
Result
If the parameters are valid, the operator write_messagewrite_messageWriteMessageWriteMessageWriteMessage returns
the value 2 (H_MSG_TRUE). If necessary an exception is raised.
Possible Predecessors
read_messageread_messageReadMessageReadMessageReadMessage,
deserialize_handledeserialize_handleDeserializeHandleDeserializeHandleDeserializeHandle,
create_messagecreate_messageCreateMessageCreateMessageCreateMessage
Possible Successors
read_messageread_messageReadMessageReadMessageReadMessage
See also
read_messageread_messageReadMessageReadMessageReadMessage,
serialize_handleserialize_handleSerializeHandleSerializeHandleSerializeHandle,
deserialize_handledeserialize_handleDeserializeHandleDeserializeHandleDeserializeHandle
Module
Foundation