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

Represents an external file reference class More...

Inheritance diagram for NXOpen.ExternalFileReference:
NXOpen.TransientObject NXOpen.Utilities.NXRemotableObject IDisposable IMessageSink

Public Types

enum  Status {
  Ok, FileMoved, FileOutOfDate, FileNotFound,
  Invalid
}
 Define the ExternalFileReference status code More...
 

Public Member Functions

unsafe string GetExternalFileName ()
 Gets the file name for the external file More...
 
unsafe string GetExternalFileSpec ()
 Gets the file spec for the external file More...
 
unsafe void GetReferencingApplicationObjects (out NXOpen.NXObject[] objects)
 Gets all the application objects that are referencing this external file reference. More...
 
unsafe string GetTimeStampWithStatus (out NXOpen.ExternalFileReference.Status status)
 Gets the time stamp data for the external file in the format: 28-Apr-2001 22:06:15. More...
 
- Public Member Functions inherited from NXOpen.TransientObject
void Dispose ()
 Frees the object from memory. More...
 
void PrintTestData (String variableName)
 <exclude> More...
 
void PrintTestData (String variableName, int lineNumber)
 <exclude> More...
 
new string ToString ()
 Returns a String that represents the current Object. 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...
 

Protected Member Functions

override void FreeResource ()
 Free resources associated with the instance. More...
 

Additional Inherited Members

- Properties inherited from NXOpen.TransientObject
IntPtr Handle [get]
 Handle of the internal object represented by this object. More...
 

Detailed Description

Represents an external file reference class

Use NXOpen.ExternalFileReferenceManager.GetExternalFileReferences to get instance of this class.

Created in NX1847.0.0

Member Enumeration Documentation

Define the ExternalFileReference status code

Enumerator
Ok 
FileMoved 
FileOutOfDate 
FileNotFound 
Invalid 

Member Function Documentation

override void NXOpen.ExternalFileReference.FreeResource ( )
inlineprotectedvirtual

Free resources associated with the instance.

After this method is called, it is illegal to use the object. In .NET, this method is automatically called when the object is deleted by the garbage collector

Created in NX1899.0.0

License requirements: None.

Implements NXOpen.TransientObject.

unsafe string NXOpen.ExternalFileReference.GetExternalFileName ( )
inline

Gets the file name for the external file

Created in NX1899.0.0

License requirements: None.

Returns
unsafe string NXOpen.ExternalFileReference.GetExternalFileSpec ( )
inline

Gets the file spec for the external file

Created in NX1899.0.0

License requirements: None.

Returns
unsafe void NXOpen.ExternalFileReference.GetReferencingApplicationObjects ( out NXOpen.NXObject[]  objects)
inline

Gets all the application objects that are referencing this external file reference.

Created in NX1899.0.0

License requirements: None.

Parameters
objects
unsafe string NXOpen.ExternalFileReference.GetTimeStampWithStatus ( out NXOpen.ExternalFileReference.Status  status)
inline

Gets the time stamp data for the external file in the format: 28-Apr-2001 22:06:15.

Also evaulates the status of the list of ExternalFileReference objects. If the status has not changed then the status is 0. Some of the other status codes that can be returned are- 580165 - Out of date reference 1020001 - File not found

Created in NX1899.0.0

License requirements: None.

Returns
Parameters
status

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