NXOpen .NET Reference  12.0.0
Public Member Functions | List of all members
NXOpen.UF.UF Class Reference

Contains wrappers for all 'UF' functions and data types. More...

Inheritance diagram for NXOpen.UF.UF:

Public Member Functions

delegate void CallbackFnT (CallbackReason _X1, IntPtr _X2, IntPtr _X3)
 This delegate is equivalent to 'UF_callback_fn_t'. More...
 
delegate void LoadFPT ()
 This delegate is equivalent to 'UF_load_f_p_t'. More...
 
unsafe delegate void OutputLineOfTextFT (sbyte *line_of_text)
 This delegate is equivalent to 'UF_output_line_of_text_f_t'. More...
 
void AddCallbackFunction (CallbackReason reason, CallbackFnT fn, IntPtr user_data, out IntPtr function_id)
 Wrapper method for UF_add_callback_function More...
 
IntPtr AllocateMemory (uint nbytes)
 Wrapper method for UF_allocate_memory More...
 
void AskApplicationModule (out int module_id)
 Wrapper method for UF_ask_application_module More...
 
void AskCodeset (out Codeset codeset)
 Wrapper method for UF_ask_codeset More...
 
unsafe void AskGripArgs (int argument_count, ref Args gruf_arg_list)
 DEPRECATED Wrapper method for UF_ask_grip_args More...
 
unsafe void AskSyslogFilename (out string filename)
 Wrapper method for UF_ask_syslog_filename More...
 
unsafe void AskSystemInfo (out SystemInfo info)
 Wrapper method for UF_ask_system_info More...
 
void BeginTimer (out short timer)
 Wrapper method for UF_begin_timer More...
 
void DecodeAuthFile (int key, string input_file, out IntPtr out_mem)
 Wrapper method for UF_decode_auth_file More...
 
void EncodeAuthFile (int key, string input_file, string output_file)
 Wrapper method for UF_encode_auth_file More...
 
void EndTimer (short timer, out TimerValues values)
 Wrapper method for UF_end_timer More...
 
unsafe void FindAllSubdirectories (string subdirectory, out int num_found, out string[] path)
 Wrapper method for UF_find_all_subdirectories More...
 
unsafe void FindFile (string subdirectory, string filename, out string path)
 Wrapper method for UF_find_file More...
 
void Free (IntPtr data)
 Wrapper method for UF_free More...
 
unsafe void GetCustomerDefault (string name, int units, out string default_value)
 Wrapper method for UF_get_customer_default More...
 
unsafe void GetFailMessage (int fail_code, out string message)
 Wrapper method for UF_get_fail_message More...
 
unsafe void GetRelease (out string release)
 Wrapper method for UF_get_release More...
 
unsafe void GetReservedLicenses (string context_name, out int n_licenses, out string[] licenses)
 Wrapper method for UF_get_reserved_licenses More...
 
unsafe void GetTranslatedFailMessage (int fail_code, out string message)
 Wrapper method for UF_get_translated_fail_message More...
 
void InitializeDm ()
 Wrapper method for UF_initialize_dm More...
 
int IsInitialized ()
 Wrapper method for UF_is_initialized More...
 
void IsUgmanagerActive (out bool is_active)
 Wrapper method for UF_is_ugmanager_active More...
 
void OutputCopyright (OutputLineOfTextFT output_line_of_text)
 Wrapper method for UF_output_copyright More...
 
void PrintSyslog (string message, bool trace)
 Wrapper method for UF_print_syslog More...
 
IntPtr ReallocateMemory (IntPtr data, uint nbytes)
 Wrapper method for UF_reallocate_memory More...
 
void Release (string license, string context_name)
 Wrapper method for UF_release More...
 
void ReleaseAll (string context_name)
 Wrapper method for UF_release_all More...
 
void RemoveCallbackFunction (IntPtr function_id)
 Wrapper method for UF_remove_callback_function More...
 
void Reserve (string license, string context_name)
 Wrapper method for UF_reserve More...
 
void SetRetiringFlag (int value)
 Wrapper method for UF_set_retiring_flag More...
 
void SetVariable (string variable, string value)
 Wrapper method for UF_set_variable More...
 
unsafe void TranslateVariable (string variable, out string translation)
 Wrapper method for UF_translate_variable More...
 
void UnloadLibrary (string library_name)
 Wrapper method for UF_unload_library More...
 

Detailed Description

Contains wrappers for all 'UF' functions and data types.

Member Function Documentation

void NXOpen.UF.UF.AddCallbackFunction ( CallbackReason  reason,
CallbackFnT  fn,
IntPtr  user_data,
out IntPtr  function_id 
)

Wrapper method for UF_add_callback_function

Refer to UF_add_callback_function for documentation
Mapping Help

This method should not be used in journal replay.

License requirements:None

IntPtr NXOpen.UF.UF.AllocateMemory ( uint  nbytes)

Wrapper method for UF_allocate_memory

Refer to UF_allocate_memory for documentation
Mapping Help

License requirements:None

void NXOpen.UF.UF.AskApplicationModule ( out int  module_id)

Wrapper method for UF_ask_application_module

Refer to UF_ask_application_module for documentation
Mapping Help

License requirements:None

void NXOpen.UF.UF.AskCodeset ( out Codeset  codeset)

Wrapper method for UF_ask_codeset

Refer to UF_ask_codeset for documentation
Mapping Help

License requirements:None

unsafe void NXOpen.UF.UF.AskGripArgs ( int  argument_count,
ref Args  gruf_arg_list 
)

DEPRECATED Wrapper method for UF_ask_grip_args

Refer to UF_ask_grip_args for documentation
Mapping Help

License requirements:None

unsafe void NXOpen.UF.UF.AskSyslogFilename ( out string  filename)

Wrapper method for UF_ask_syslog_filename

Refer to UF_ask_syslog_filename for documentation
Mapping Help

License requirements:None

unsafe void NXOpen.UF.UF.AskSystemInfo ( out SystemInfo  info)

Wrapper method for UF_ask_system_info

Refer to UF_ask_system_info for documentation
Mapping Help

License requirements:None

void NXOpen.UF.UF.BeginTimer ( out short  timer)

Wrapper method for UF_begin_timer

Refer to UF_begin_timer for documentation
Mapping Help

License requirements:None

delegate void NXOpen.UF.UF.CallbackFnT ( CallbackReason  _X1,
IntPtr  _X2,
IntPtr  _X3 
)

This delegate is equivalent to 'UF_callback_fn_t'.

void NXOpen.UF.UF.DecodeAuthFile ( int  key,
string  input_file,
out IntPtr  out_mem 
)

Wrapper method for UF_decode_auth_file

Refer to UF_decode_auth_file for documentation
Mapping Help

License requirements:None

void NXOpen.UF.UF.EncodeAuthFile ( int  key,
string  input_file,
string  output_file 
)

Wrapper method for UF_encode_auth_file

Refer to UF_encode_auth_file for documentation
Mapping Help

License requirements:None

void NXOpen.UF.UF.EndTimer ( short  timer,
out TimerValues  values 
)

Wrapper method for UF_end_timer

Refer to UF_end_timer for documentation
Mapping Help

License requirements:None

unsafe void NXOpen.UF.UF.FindAllSubdirectories ( string  subdirectory,
out int  num_found,
out string[]  path 
)

Wrapper method for UF_find_all_subdirectories

Refer to UF_find_all_subdirectories for documentation
Mapping Help

License requirements:None

unsafe void NXOpen.UF.UF.FindFile ( string  subdirectory,
string  filename,
out string  path 
)

Wrapper method for UF_find_file

Refer to UF_find_file for documentation
Mapping Help

License requirements:None

void NXOpen.UF.UF.Free ( IntPtr  data)

Wrapper method for UF_free

Refer to UF_free for documentation
Mapping Help

License requirements:None

unsafe void NXOpen.UF.UF.GetCustomerDefault ( string  name,
int  units,
out string  default_value 
)

Wrapper method for UF_get_customer_default

Refer to UF_get_customer_default for documentation
Mapping Help

License requirements:None

unsafe void NXOpen.UF.UF.GetFailMessage ( int  fail_code,
out string  message 
)

Wrapper method for UF_get_fail_message

Refer to UF_get_fail_message for documentation
Mapping Help

License requirements:None

unsafe void NXOpen.UF.UF.GetRelease ( out string  release)

Wrapper method for UF_get_release

Refer to UF_get_release for documentation
Mapping Help

License requirements:None

unsafe void NXOpen.UF.UF.GetReservedLicenses ( string  context_name,
out int  n_licenses,
out string[]  licenses 
)

Wrapper method for UF_get_reserved_licenses

Refer to UF_get_reserved_licenses for documentation
Mapping Help

License requirements:None

unsafe void NXOpen.UF.UF.GetTranslatedFailMessage ( int  fail_code,
out string  message 
)

Wrapper method for UF_get_translated_fail_message

Refer to UF_get_translated_fail_message for documentation
Mapping Help

License requirements:None

void NXOpen.UF.UF.InitializeDm ( )

Wrapper method for UF_initialize_dm

Refer to UF_initialize_dm for documentation
Mapping Help

License requirements:None

int NXOpen.UF.UF.IsInitialized ( )

Wrapper method for UF_is_initialized

Refer to UF_is_initialized for documentation
Mapping Help

License requirements:None

void NXOpen.UF.UF.IsUgmanagerActive ( out bool  is_active)

Wrapper method for UF_is_ugmanager_active

Refer to UF_is_ugmanager_active for documentation
Mapping Help

License requirements:None

delegate void NXOpen.UF.UF.LoadFPT ( )

This delegate is equivalent to 'UF_load_f_p_t'.

void NXOpen.UF.UF.OutputCopyright ( OutputLineOfTextFT  output_line_of_text)

Wrapper method for UF_output_copyright

Refer to UF_output_copyright for documentation
Mapping Help

License requirements:None

unsafe delegate void NXOpen.UF.UF.OutputLineOfTextFT ( sbyte *  line_of_text)

This delegate is equivalent to 'UF_output_line_of_text_f_t'.

void NXOpen.UF.UF.PrintSyslog ( string  message,
bool  trace 
)

Wrapper method for UF_print_syslog

Refer to UF_print_syslog for documentation
Mapping Help

License requirements:None

IntPtr NXOpen.UF.UF.ReallocateMemory ( IntPtr  data,
uint  nbytes 
)

Wrapper method for UF_reallocate_memory

Refer to UF_reallocate_memory for documentation
Mapping Help

License requirements:None

void NXOpen.UF.UF.Release ( string  license,
string  context_name 
)

Wrapper method for UF_release

Refer to UF_release for documentation
Mapping Help

License requirements:None

void NXOpen.UF.UF.ReleaseAll ( string  context_name)

Wrapper method for UF_release_all

Refer to UF_release_all for documentation
Mapping Help

License requirements:None

void NXOpen.UF.UF.RemoveCallbackFunction ( IntPtr  function_id)

Wrapper method for UF_remove_callback_function

Refer to UF_remove_callback_function for documentation
Mapping Help

License requirements:None

void NXOpen.UF.UF.Reserve ( string  license,
string  context_name 
)

Wrapper method for UF_reserve

Refer to UF_reserve for documentation
Mapping Help

License requirements:None

void NXOpen.UF.UF.SetRetiringFlag ( int  value)

Wrapper method for UF_set_retiring_flag

Refer to UF_set_retiring_flag for documentation
Mapping Help

License requirements:None

void NXOpen.UF.UF.SetVariable ( string  variable,
string  value 
)

Wrapper method for UF_set_variable

Refer to UF_set_variable for documentation
Mapping Help

License requirements:None

unsafe void NXOpen.UF.UF.TranslateVariable ( string  variable,
out string  translation 
)

Wrapper method for UF_translate_variable

Refer to UF_translate_variable for documentation
Mapping Help

License requirements:None

void NXOpen.UF.UF.UnloadLibrary ( string  library_name)

Wrapper method for UF_unload_library

Refer to UF_unload_library for documentation
Mapping Help

License requirements:None


The documentation for this class was generated from the following file:
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.