NXOpen .NET Reference Guide  1899
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties
Classes | Public Member Functions | List of all members
NXOpen.UF.UFAttr Class Reference

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

Inheritance diagram for NXOpen.UF.UFAttr:
NXOpen.Utilities.NXRemotableObject IMessageSink

Classes

struct  _Info
 
struct  _Iterator
 
struct  Info
 Wrapper for UF_ATTR_info_s More...
 
struct  Iterator
 Wrapper for UF_ATTR_iterator_s More...
 

Public Member Functions

void AskLocked (NXOpen.Tag _object, string title, out bool locked)
 DEPRECATED Wrapper method for UF_ATTR_ask_locked More...
 
void AskPartAttribute (out NXOpen.Tag attribute)
 DEPRECATED Wrapper method for UF_ATTR_ask_part_attribute More...
 
void CountAttributes (NXOpen.Tag _object, int type, out int count)
 DEPRECATED Wrapper method for UF_ATTR_count_attributes More...
 
unsafe void CountUserAttributes (NXOpen.Tag _object, ref Iterator iter, out int count)
 Wrapper method for UF_ATTR_count_user_attributes More...
 
unsafe void CountUserAttributeTitles (NXOpen.Tag _object, ref Iterator iter, out int count)
 Wrapper method for UF_ATTR_count_user_attribute_titles More...
 
void Delete (NXOpen.Tag _object, int type, string title)
 DEPRECATED Wrapper method for UF_ATTR_delete More...
 
void DeleteAll (NXOpen.Tag _object, int type)
 DEPRECATED Wrapper method for UF_ATTR_delete_all More...
 
unsafe void DeleteUserAttributes (NXOpen.Tag _object, ref Iterator iter, bool update)
 Wrapper method for UF_ATTR_delete_user_attributes More...
 
void DeleteUserAttributeWithTitleAndType (NXOpen.Tag _object, string title, int type, int index, bool update)
 Wrapper method for UF_ATTR_delete_user_attribute_with_title_and_type More...
 
void FindAttribute (NXOpen.Tag _object, int type, string title, out int title_type)
 DEPRECATED Wrapper method for UF_ATTR_find_attribute More...
 
unsafe void FreeUserAttributeInfoArray (int count, Info[] info)
 DEPRECATED Wrapper method for UF_ATTR_free_user_attribute_info_array More...
 
unsafe void FreeUserAttributeInfoStrings (ref Info info)
 Wrapper method for UF_ATTR_free_user_attribute_info_strings More...
 
unsafe void FreeUserAttributeIteratorStrings (ref Iterator iterator)
 Wrapper method for UF_ATTR_free_user_attribute_iterator_strings More...
 
void GetBoolUserAttribute (NXOpen.Tag _object, string title, int index, out bool value, out bool has_attribute)
 Wrapper method for UF_ATTR_get_bool_user_attribute More...
 
void GetComputationalTimeUserAttribute (NXOpen.Tag _object, string title, int index,[Out] int[] value, out bool has_attribute)
 Wrapper method for UF_ATTR_get_computational_time_user_attribute More...
 
void GetIntegerUserAttribute (NXOpen.Tag _object, string title, int index, out int value, out bool has_attribute)
 Wrapper method for UF_ATTR_get_integer_user_attribute More...
 
unsafe void GetNextUserAttribute (NXOpen.Tag _object, ref Iterator iter, out Info info, out bool has_attribute)
 Wrapper method for UF_ATTR_get_next_user_attribute More...
 
void GetNullUserAttribute (NXOpen.Tag _object, string title, int index, out bool has_attribute)
 Wrapper method for UF_ATTR_get_null_user_attribute More...
 
void GetRealUserAttribute (NXOpen.Tag _object, string title, int index, out double value, out NXOpen.Tag unit_type, out bool has_attribute)
 Wrapper method for UF_ATTR_get_real_user_attribute More...
 
unsafe void GetReferenceStringOfUserAttribute (NXOpen.Tag _object, string title, int index, out string reference_string, out bool has_attribute)
 Wrapper method for UF_ATTR_get_reference_string_of_user_attribute More...
 
unsafe void GetStringTimeUserAttribute (NXOpen.Tag _object, string title, int index, out string time_string, out bool has_attribute)
 Wrapper method for UF_ATTR_get_string_time_user_attribute More...
 
unsafe void GetStringUserAttribute (NXOpen.Tag _object, string title, int index, out string string_value, out bool has_attribute)
 Wrapper method for UF_ATTR_get_string_user_attribute More...
 
unsafe void GetUserAttribute (NXOpen.Tag _object, ref Iterator iter, out Info info, out bool has_attribute)
 Wrapper method for UF_ATTR_get_user_attribute More...
 
unsafe void GetUserAttributeLock (NXOpen.Tag _object, ref Iterator iter, out bool is_locked, out bool has_attribute)
 Wrapper method for UF_ATTR_get_user_attribute_lock More...
 
void GetUserAttributeLockWithTitleAndType (NXOpen.Tag _object, string title, int type, int index, out bool is_locked, out bool has_attribute)
 Wrapper method for UF_ATTR_get_user_attribute_lock_with_title_and_type More...
 
unsafe void GetUserAttributes (NXOpen.Tag _object, ref Iterator iter, out int num_attributes, out Info[] info)
 Wrapper method for UF_ATTR_get_user_attributes More...
 
unsafe void GetUserAttributesInFile (string part_name, ref Iterator iter, out int num_attributes, out Info[] info)
 Wrapper method for UF_ATTR_get_user_attributes_in_file More...
 
unsafe void GetUserAttributeWithTitleAndType (NXOpen.Tag _object, string title, int type, int index, out Info info, out bool has_attribute)
 Wrapper method for UF_ATTR_get_user_attribute_with_title_and_type More...
 
unsafe void HasUserAttribute (NXOpen.Tag _object, ref Iterator iter, out bool has_attribute)
 Wrapper method for UF_ATTR_has_user_attribute More...
 
void HasUserAttributeWithTitleAndType (NXOpen.Tag _object, string title, int type, int index, out bool has_attribute)
 Wrapper method for UF_ATTR_has_user_attribute_with_title_and_type More...
 
unsafe void InitUserAttributeInfo (ref Info info)
 Wrapper method for UF_ATTR_init_user_attribute_info More...
 
unsafe void InitUserAttributeIterator (ref Iterator iter)
 Wrapper method for UF_ATTR_init_user_attribute_iterator More...
 
unsafe void ReleaseUserAttributeIterator (ref Iterator iter)
 Wrapper method for UF_ATTR_release_user_attribute_iterator More...
 
void SetBoolUserAttribute (NXOpen.Tag _object, string title, int index, bool value, bool update)
 Wrapper method for UF_ATTR_set_bool_user_attribute More...
 
void SetComputationalTimeUserAttribute (NXOpen.Tag _object, string title, int index, int[] value, bool update)
 Wrapper method for UF_ATTR_set_computational_time_user_attribute More...
 
void SetIntegerUserAttribute (NXOpen.Tag _object, string title, int index, int value, bool update)
 Wrapper method for UF_ATTR_set_integer_user_attribute More...
 
void SetLocked (NXOpen.Tag _object, string title, bool locked)
 DEPRECATED Wrapper method for UF_ATTR_set_locked More...
 
void SetNullUserAttribute (NXOpen.Tag _object, string title, int index, bool update)
 Wrapper method for UF_ATTR_set_null_user_attribute More...
 
void SetRealUserAttribute (NXOpen.Tag _object, string title, int index, double value, NXOpen.Tag unit_type, bool update)
 Wrapper method for UF_ATTR_set_real_user_attribute More...
 
void SetReferenceStringUserAttribute (NXOpen.Tag _object, string title, int index, string reference_string, bool update)
 Wrapper method for UF_ATTR_set_reference_string_user_attribute More...
 
void SetStringTimeUserAttribute (NXOpen.Tag _object, string title, int index, string value, bool update)
 Wrapper method for UF_ATTR_set_string_time_user_attribute More...
 
void SetStringUserAttribute (NXOpen.Tag _object, string title, int index, string value, bool update)
 Wrapper method for UF_ATTR_set_string_user_attribute More...
 
unsafe void SetTimeStringFormat (string new_format, out string old_format)
 Wrapper method for UF_ATTR_set_time_string_format More...
 
unsafe void SetUserAttribute (NXOpen.Tag _object, ref Info info, bool update)
 Wrapper method for UF_ATTR_set_user_attribute More...
 
unsafe void SetUserAttributeLocks (NXOpen.Tag _object, ref Iterator iter, bool locked)
 Wrapper method for UF_ATTR_set_user_attribute_locks More...
 
void SetUserAttributeLockWithTitleAndType (NXOpen.Tag objectTag, string title, int type, bool _lock)
 Wrapper method for UF_ATTR_set_user_attribute_lock_with_title_and_type More...
 
- Public Member Functions inherited from NXOpen.Utilities.NXRemotableObject
IMessageCtrl AsyncProcessMessage (IMessage msg, IMessageSink replySink)
 Asynchronously processes the given message. More...
 
IMessage SyncProcessMessage (IMessage msg)
 Synchronously processes the given message. More...
 

Additional Inherited Members

- Protected Member Functions inherited from NXOpen.Utilities.NXRemotableObject
void initialize ()
 <exclude> More...
 
- Properties inherited from NXOpen.Utilities.NXRemotableObject
IMessageSink NextSink [get]
 Gets the next message sink in the sink chain. More...
 

Detailed Description

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

Member Function Documentation

void NXOpen.UF.UFAttr.AskLocked ( NXOpen.Tag  _object,
string  title,
out bool  locked 
)
inline

DEPRECATED Wrapper method for UF_ATTR_ask_locked

Refer to UF_ATTR_ask_locked for documentation

License requirements:None

void NXOpen.UF.UFAttr.AskPartAttribute ( out NXOpen.Tag  attribute)
inline

DEPRECATED Wrapper method for UF_ATTR_ask_part_attribute

Refer to UF_ATTR_ask_part_attribute for documentation

License requirements:None

void NXOpen.UF.UFAttr.CountAttributes ( NXOpen.Tag  _object,
int  type,
out int  count 
)
inline

DEPRECATED Wrapper method for UF_ATTR_count_attributes

Refer to UF_ATTR_count_attributes for documentation

License requirements:None

unsafe void NXOpen.UF.UFAttr.CountUserAttributes ( NXOpen.Tag  _object,
ref Iterator  iter,
out int  count 
)
inline

Wrapper method for UF_ATTR_count_user_attributes

Refer to UF_ATTR_count_user_attributes for documentation

License requirements:None

unsafe void NXOpen.UF.UFAttr.CountUserAttributeTitles ( NXOpen.Tag  _object,
ref Iterator  iter,
out int  count 
)
inline

Wrapper method for UF_ATTR_count_user_attribute_titles

Refer to UF_ATTR_count_user_attribute_titles for documentation

License requirements:None

void NXOpen.UF.UFAttr.Delete ( NXOpen.Tag  _object,
int  type,
string  title 
)
inline

DEPRECATED Wrapper method for UF_ATTR_delete

Refer to UF_ATTR_delete for documentation

License requirements:None

void NXOpen.UF.UFAttr.DeleteAll ( NXOpen.Tag  _object,
int  type 
)
inline

DEPRECATED Wrapper method for UF_ATTR_delete_all

Refer to UF_ATTR_delete_all for documentation

License requirements:None

unsafe void NXOpen.UF.UFAttr.DeleteUserAttributes ( NXOpen.Tag  _object,
ref Iterator  iter,
bool  update 
)
inline

Wrapper method for UF_ATTR_delete_user_attributes

Refer to UF_ATTR_delete_user_attributes for documentation

License requirements:None

void NXOpen.UF.UFAttr.DeleteUserAttributeWithTitleAndType ( NXOpen.Tag  _object,
string  title,
int  type,
int  index,
bool  update 
)
inline

Wrapper method for UF_ATTR_delete_user_attribute_with_title_and_type

Refer to UF_ATTR_delete_user_attribute_with_title_and_type for documentation

License requirements:None

void NXOpen.UF.UFAttr.FindAttribute ( NXOpen.Tag  _object,
int  type,
string  title,
out int  title_type 
)
inline

DEPRECATED Wrapper method for UF_ATTR_find_attribute

Refer to UF_ATTR_find_attribute for documentation

License requirements:None

unsafe void NXOpen.UF.UFAttr.FreeUserAttributeInfoArray ( int  count,
Info[]  info 
)
inline

DEPRECATED Wrapper method for UF_ATTR_free_user_attribute_info_array

Refer to UF_ATTR_free_user_attribute_info_array for documentation

License requirements:None

unsafe void NXOpen.UF.UFAttr.FreeUserAttributeInfoStrings ( ref Info  info)
inline

Wrapper method for UF_ATTR_free_user_attribute_info_strings

Refer to UF_ATTR_free_user_attribute_info_strings for documentation

License requirements:None

unsafe void NXOpen.UF.UFAttr.FreeUserAttributeIteratorStrings ( ref Iterator  iterator)
inline

Wrapper method for UF_ATTR_free_user_attribute_iterator_strings

Refer to UF_ATTR_free_user_attribute_iterator_strings for documentation

License requirements:None

void NXOpen.UF.UFAttr.GetBoolUserAttribute ( NXOpen.Tag  _object,
string  title,
int  index,
out bool  value,
out bool  has_attribute 
)
inline

Wrapper method for UF_ATTR_get_bool_user_attribute

Refer to UF_ATTR_get_bool_user_attribute for documentation

License requirements:None

void NXOpen.UF.UFAttr.GetComputationalTimeUserAttribute ( NXOpen.Tag  _object,
string  title,
int  index,
[Out] int[]  value,
out bool  has_attribute 
)
inline

Wrapper method for UF_ATTR_get_computational_time_user_attribute

Refer to UF_ATTR_get_computational_time_user_attribute for documentation

License requirements:None

void NXOpen.UF.UFAttr.GetIntegerUserAttribute ( NXOpen.Tag  _object,
string  title,
int  index,
out int  value,
out bool  has_attribute 
)
inline

Wrapper method for UF_ATTR_get_integer_user_attribute

Refer to UF_ATTR_get_integer_user_attribute for documentation

License requirements:None

unsafe void NXOpen.UF.UFAttr.GetNextUserAttribute ( NXOpen.Tag  _object,
ref Iterator  iter,
out Info  info,
out bool  has_attribute 
)
inline

Wrapper method for UF_ATTR_get_next_user_attribute

Refer to UF_ATTR_get_next_user_attribute for documentation

License requirements:None

void NXOpen.UF.UFAttr.GetNullUserAttribute ( NXOpen.Tag  _object,
string  title,
int  index,
out bool  has_attribute 
)
inline

Wrapper method for UF_ATTR_get_null_user_attribute

Refer to UF_ATTR_get_null_user_attribute for documentation

License requirements:None

void NXOpen.UF.UFAttr.GetRealUserAttribute ( NXOpen.Tag  _object,
string  title,
int  index,
out double  value,
out NXOpen.Tag  unit_type,
out bool  has_attribute 
)
inline

Wrapper method for UF_ATTR_get_real_user_attribute

Refer to UF_ATTR_get_real_user_attribute for documentation

License requirements:None

unsafe void NXOpen.UF.UFAttr.GetReferenceStringOfUserAttribute ( NXOpen.Tag  _object,
string  title,
int  index,
out string  reference_string,
out bool  has_attribute 
)
inline

Wrapper method for UF_ATTR_get_reference_string_of_user_attribute

Refer to UF_ATTR_get_reference_string_of_user_attribute for documentation

License requirements:None

unsafe void NXOpen.UF.UFAttr.GetStringTimeUserAttribute ( NXOpen.Tag  _object,
string  title,
int  index,
out string  time_string,
out bool  has_attribute 
)
inline

Wrapper method for UF_ATTR_get_string_time_user_attribute

Refer to UF_ATTR_get_string_time_user_attribute for documentation

License requirements:None

unsafe void NXOpen.UF.UFAttr.GetStringUserAttribute ( NXOpen.Tag  _object,
string  title,
int  index,
out string  string_value,
out bool  has_attribute 
)
inline

Wrapper method for UF_ATTR_get_string_user_attribute

Refer to UF_ATTR_get_string_user_attribute for documentation

License requirements:None

unsafe void NXOpen.UF.UFAttr.GetUserAttribute ( NXOpen.Tag  _object,
ref Iterator  iter,
out Info  info,
out bool  has_attribute 
)
inline

Wrapper method for UF_ATTR_get_user_attribute

Refer to UF_ATTR_get_user_attribute for documentation

License requirements:None

unsafe void NXOpen.UF.UFAttr.GetUserAttributeLock ( NXOpen.Tag  _object,
ref Iterator  iter,
out bool  is_locked,
out bool  has_attribute 
)
inline

Wrapper method for UF_ATTR_get_user_attribute_lock

Refer to UF_ATTR_get_user_attribute_lock for documentation

License requirements:None

void NXOpen.UF.UFAttr.GetUserAttributeLockWithTitleAndType ( NXOpen.Tag  _object,
string  title,
int  type,
int  index,
out bool  is_locked,
out bool  has_attribute 
)
inline

Wrapper method for UF_ATTR_get_user_attribute_lock_with_title_and_type

Refer to UF_ATTR_get_user_attribute_lock_with_title_and_type for documentation

License requirements:None

unsafe void NXOpen.UF.UFAttr.GetUserAttributes ( NXOpen.Tag  _object,
ref Iterator  iter,
out int  num_attributes,
out Info[]  info 
)
inline

Wrapper method for UF_ATTR_get_user_attributes

Refer to UF_ATTR_get_user_attributes for documentation

License requirements:None

unsafe void NXOpen.UF.UFAttr.GetUserAttributesInFile ( string  part_name,
ref Iterator  iter,
out int  num_attributes,
out Info[]  info 
)
inline

Wrapper method for UF_ATTR_get_user_attributes_in_file

Refer to UF_ATTR_get_user_attributes_in_file for documentation

License requirements:None

unsafe void NXOpen.UF.UFAttr.GetUserAttributeWithTitleAndType ( NXOpen.Tag  _object,
string  title,
int  type,
int  index,
out Info  info,
out bool  has_attribute 
)
inline

Wrapper method for UF_ATTR_get_user_attribute_with_title_and_type

Refer to UF_ATTR_get_user_attribute_with_title_and_type for documentation

License requirements:None

unsafe void NXOpen.UF.UFAttr.HasUserAttribute ( NXOpen.Tag  _object,
ref Iterator  iter,
out bool  has_attribute 
)
inline

Wrapper method for UF_ATTR_has_user_attribute

Refer to UF_ATTR_has_user_attribute for documentation

License requirements:None

void NXOpen.UF.UFAttr.HasUserAttributeWithTitleAndType ( NXOpen.Tag  _object,
string  title,
int  type,
int  index,
out bool  has_attribute 
)
inline

Wrapper method for UF_ATTR_has_user_attribute_with_title_and_type

Refer to UF_ATTR_has_user_attribute_with_title_and_type for documentation

License requirements:None

unsafe void NXOpen.UF.UFAttr.InitUserAttributeInfo ( ref Info  info)
inline

Wrapper method for UF_ATTR_init_user_attribute_info

Refer to UF_ATTR_init_user_attribute_info for documentation

License requirements:None

unsafe void NXOpen.UF.UFAttr.InitUserAttributeIterator ( ref Iterator  iter)
inline

Wrapper method for UF_ATTR_init_user_attribute_iterator

Refer to UF_ATTR_init_user_attribute_iterator for documentation

License requirements:None

unsafe void NXOpen.UF.UFAttr.ReleaseUserAttributeIterator ( ref Iterator  iter)
inline

Wrapper method for UF_ATTR_release_user_attribute_iterator

Refer to UF_ATTR_release_user_attribute_iterator for documentation

License requirements:None

void NXOpen.UF.UFAttr.SetBoolUserAttribute ( NXOpen.Tag  _object,
string  title,
int  index,
bool  value,
bool  update 
)
inline

Wrapper method for UF_ATTR_set_bool_user_attribute

Refer to UF_ATTR_set_bool_user_attribute for documentation

License requirements:None

void NXOpen.UF.UFAttr.SetComputationalTimeUserAttribute ( NXOpen.Tag  _object,
string  title,
int  index,
int[]  value,
bool  update 
)
inline

Wrapper method for UF_ATTR_set_computational_time_user_attribute

Refer to UF_ATTR_set_computational_time_user_attribute for documentation

License requirements:None

void NXOpen.UF.UFAttr.SetIntegerUserAttribute ( NXOpen.Tag  _object,
string  title,
int  index,
int  value,
bool  update 
)
inline

Wrapper method for UF_ATTR_set_integer_user_attribute

Refer to UF_ATTR_set_integer_user_attribute for documentation

License requirements:None

void NXOpen.UF.UFAttr.SetLocked ( NXOpen.Tag  _object,
string  title,
bool  locked 
)
inline

DEPRECATED Wrapper method for UF_ATTR_set_locked

Refer to UF_ATTR_set_locked for documentation

License requirements:None

void NXOpen.UF.UFAttr.SetNullUserAttribute ( NXOpen.Tag  _object,
string  title,
int  index,
bool  update 
)
inline

Wrapper method for UF_ATTR_set_null_user_attribute

Refer to UF_ATTR_set_null_user_attribute for documentation

License requirements:None

void NXOpen.UF.UFAttr.SetRealUserAttribute ( NXOpen.Tag  _object,
string  title,
int  index,
double  value,
NXOpen.Tag  unit_type,
bool  update 
)
inline

Wrapper method for UF_ATTR_set_real_user_attribute

Refer to UF_ATTR_set_real_user_attribute for documentation

License requirements:None

void NXOpen.UF.UFAttr.SetReferenceStringUserAttribute ( NXOpen.Tag  _object,
string  title,
int  index,
string  reference_string,
bool  update 
)
inline

Wrapper method for UF_ATTR_set_reference_string_user_attribute

Refer to UF_ATTR_set_reference_string_user_attribute for documentation

License requirements:None

void NXOpen.UF.UFAttr.SetStringTimeUserAttribute ( NXOpen.Tag  _object,
string  title,
int  index,
string  value,
bool  update 
)
inline

Wrapper method for UF_ATTR_set_string_time_user_attribute

Refer to UF_ATTR_set_string_time_user_attribute for documentation

License requirements:None

void NXOpen.UF.UFAttr.SetStringUserAttribute ( NXOpen.Tag  _object,
string  title,
int  index,
string  value,
bool  update 
)
inline

Wrapper method for UF_ATTR_set_string_user_attribute

Refer to UF_ATTR_set_string_user_attribute for documentation

License requirements:None

unsafe void NXOpen.UF.UFAttr.SetTimeStringFormat ( string  new_format,
out string  old_format 
)
inline

Wrapper method for UF_ATTR_set_time_string_format

Refer to UF_ATTR_set_time_string_format for documentation

License requirements:None

unsafe void NXOpen.UF.UFAttr.SetUserAttribute ( NXOpen.Tag  _object,
ref Info  info,
bool  update 
)
inline

Wrapper method for UF_ATTR_set_user_attribute

Refer to UF_ATTR_set_user_attribute for documentation

License requirements:None

unsafe void NXOpen.UF.UFAttr.SetUserAttributeLocks ( NXOpen.Tag  _object,
ref Iterator  iter,
bool  locked 
)
inline

Wrapper method for UF_ATTR_set_user_attribute_locks

Refer to UF_ATTR_set_user_attribute_locks for documentation

License requirements:None

void NXOpen.UF.UFAttr.SetUserAttributeLockWithTitleAndType ( NXOpen.Tag  objectTag,
string  title,
int  type,
bool  _lock 
)
inline

Wrapper method for UF_ATTR_set_user_attribute_lock_with_title_and_type

Refer to UF_ATTR_set_user_attribute_lock_with_title_and_type for documentation

License requirements:None


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