Skip to content

write_messageWriteMessageWriteMessagewrite_messageT_write_message🔗

Short description🔗

write_messageWriteMessageWriteMessagewrite_messageT_write_message — Write a message to a file.

Signature🔗

write_message( message MessageHandle, filename.write FileName, attribute.name GenParamName, attribute.name GenParamValue )void WriteMessage( const HTuple& MessageHandle, const HTuple& FileName, const HTuple& GenParamName, const HTuple& GenParamValue )static void HOperatorSet.WriteMessage( HTuple messageHandle, HTuple fileName, HTuple genParamName, HTuple genParamValue )def write_message( message_handle: HHandle, file_name: str, gen_param_name: MaybeSequence[str], gen_param_value: MaybeSequence[Union[int, float, str]] ) -> None

Herror T_write_message( 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)

void HMessage.WriteMessage( string fileName, HTuple genParamName, HTuple genParamValue )

void HMessage.WriteMessage( string fileName, string genParamName, string genParamValue )

Description🔗

write_messageWriteMessage writes the message denoted by the MessageHandlemessageHandlemessage_handle to the file given by FileNamefileNamefile_name. The default HALCON file extension for a message is 'hmsg'.

If MessageHandlemessageHandlemessage_handle 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 GenParamNamegenParamNamegen_param_name 'raise_error_if_content_not_serializable'"raise_error_if_content_not_serializable", and the corresponding GenParamValuegenParamValuegen_param_value can take the following values:

  • 'true'"true": The default: Errors are raised and the writing process aborted.

  • 'low_level'"low_level": Only low level errors are raised. Instead of the handle concerned an empty handle is written in FileNamefileNamefile_name and the writing process will be continued. The behavior regarding HALCON low level errors is determined by 'do_low_error'"do_low_error" in set_systemSetSystem.

  • 'false'"false": The errors are suppressed. Instead of the handle concerned an empty handle is written in FileNamefileNamefile_name and the writing process will be continued.

Execution information🔗

Execution information

  • Multithreading type: reentrant (runs in parallel with non-exclusive operators).

  • Multithreading scope: global (may be called from any thread).

  • Processed without parallelization.

Parameters🔗

MessageHandlemessageHandlemessage_handle (input_control) message → (handle)HTuple (HHandle)HMessage, HTuple (IntPtr)HHandleHtuple (handle)

Message handle.

Number of elements: MessageHandle == 1
Restriction: MessageHandle != 0

FileNamefileNamefile_name (input_control) filename.write → (string)HTuple (HString)HTuple (string)strHtuple (char*)

File name.

File extension: .hmsg

GenParamNamegenParamNamegen_param_name (input_control) attribute.name(-array) → (string)HTuple (HString)HTuple (string)MaybeSequence[str]Htuple (char*)

Name of the generic parameter.

Default: [][]
List of values: 'raise_error_if_content_not_serializable'"raise_error_if_content_not_serializable"

GenParamValuegenParamValuegen_param_value (input_control) attribute.name(-array) → (string / integer / real)HTuple (HString / Hlong / double)HTuple (string / int / long / double)MaybeSequence[Union[int, float, str]]Htuple (char* / Hlong / double)

Value of the generic parameter.

Default: [][]
Suggested values: 'true', 'false', 'low_level'"true", "false", "low_level"

Result🔗

If the parameters are valid, the operator write_messageWriteMessage returns the value 2 (H_MSG_TRUE). If necessary an exception is raised.

Combinations with other operators🔗

Combinations

Possible predecessors

read_messageReadMessage, deserialize_handleDeserializeHandle, create_messageCreateMessage

Possible successors

read_messageReadMessage

See also

read_messageReadMessage, serialize_handleSerializeHandle, deserialize_handleDeserializeHandle

Module🔗

Foundation