AnsweredAssumed Answered

How to get IEdmFile object in OnCmd routine (API question)

Question asked by Alexander Leisentritt on Nov 4, 2009
Latest reply on Feb 16, 2012 by Wayne Matus

Like • Show 0 Likes0
Comment • 5

Hi,

I searched the API doc and the forums and the internet for almost two hours now and I don't find an answer.

I am programming an AddIn for PDMWE and I want to read the values of a specific file.

I don't find any routine in the API where I can generate a IEdmFile7 object by an ID or without the full path of the file.

All examples in the doc need a file object in the call but how can I get that object from the things I know in the OnCmd routine aka the contents of the ppoData array?

Any help appriciated.

Regards

Alexander

Jeff Sweeney Nov 6, 2009 6:27 PM

Correct Answer

I'm with you Alexander, it is frustrating -almost all of the example assume you already have the file object.

I think the reason why they are so vague is that methods for getting the file object differ depending on how the OnCmd routine was called. i.e. the parameters [ppoData] sent the OnCmd are different if the routine was called from a RMB click, from a button in a datacard or even different trigger types. Check the help file to see how the parameters are sent.

Here is a simple example of how I get the file object if called via RMB click:

First you need the vault object:

objVault = poCmd.mpoVault

Then once you have that, you can get the file object from the ID:

objFile = objVault.GetObject(EdmObjectType.EdmObject_File, ppoData(X).mlObjectID1)

Replace X with the number of file you are working with...if you have only one file selected, use 0. If you have more than one, typically you'ld cycle through with a For...Next loop.

See the reply in context

No one else had this question

Outcomes

Alexander Leisentritt Nov 4, 2009 7:10 AM

Ok my fault... well I searched long but i think i found it...

Its the "IEdmVault5::GetObject" function... sorry for bothering...

Actions

Jeff Sweeney @ Alexander Leisentritt on Nov 6, 2009 6:27 PM

I'm with you Alexander, it is frustrating -almost all of the example assume you already have the file object.

Here is a simple example of how I get the file object if called via RMB click:

First you need the vault object:

objVault = poCmd.mpoVault

Then once you have that, you can get the file object from the ID:

objFile = objVault.GetObject(EdmObjectType.EdmObject_File, ppoData(X).mlObjectID1)

Replace X with the number of file you are working with...if you have only one file selected, use 0. If you have more than one, typically you'ld cycle through with a For...Next loop.

Actions

Alexander Leisentritt @ Jeff Sweeney on Nov 8, 2009 1:24 PM

Thanks Jeff, I found the listing which data ppoData returnswhen called by different actions. The one i was actually missing was the GetObject function of the vault. I had everything but to get an object of an ID. And ironically I found that function 5 minutes after I wrote the question post...

Actions

Brian Dalton @ Jeff Sweeney on Feb 16, 2012 6:57 PM

This could be very helpful - if the file ID is persistent. I have been working on a macro that stores info about files in a spreadsheet for later retrieval, and so far I've been storing the path. That could be fragile if the file were moved...

So, if I stored the ID of the file instead, could I be certain that it would not change even if the file was moved to a different location within the vault? How about if the file was renamed?

Just how persistent is the File ID?

Actions

Wayne Matus @ Brian Dalton on Feb 16, 2012 7:39 PM

The fileID is persistent. When a file is first added to the vault a record is added to the database documents table and one field in this record is the fileID. This fileID is a unique field in the documents table. No two files can have the same fileID. If a file is deleted, the record is not. There is just a Deleted field that indicates the file no longer exists in the vault. So if a file is deleted, you do not have to worry about some other file being assigned that fileID.

Actions

5 Replies

Alexander Leisentritt Nov 4, 2009 7:10 AM
Mark Correct
Correct Answer
Ok my fault... well I searched long but i think i found it...

Its the "IEdmVault5::GetObject" function... sorry for bothering...
Like • Show 0 Likes0
Actions
- Jeff Sweeney @ Alexander Leisentritt on Nov 6, 2009 6:27 PM
  Unmark Correct
  Correct Answer
  I'm with you Alexander, it is frustrating -almost all of the example assume you already have the file object.
  
  I think the reason why they are so vague is that methods for getting the file object differ depending on how the OnCmd routine was called. i.e. the parameters [ppoData] sent the OnCmd are different if the routine was called from a RMB click, from a button in a datacard or even different trigger types. Check the help file to see how the parameters are sent.
  
  Here is a simple example of how I get the file object if called via RMB click:
  
  First you need the vault object:
  objVault = poCmd.mpoVault
  
  Then once you have that, you can get the file object from the ID:
  objFile = objVault.GetObject(EdmObjectType.EdmObject_File, ppoData(X).mlObjectID1)
  
  Replace X with the number of file you are working with...if you have only one file selected, use 0. If you have more than one, typically you'ld cycle through with a For...Next loop.
  Like • Show 0 Likes0
  Actions
  - Alexander Leisentritt @ Jeff Sweeney on Nov 8, 2009 1:24 PM
    Mark Correct
    Correct Answer
    Thanks Jeff, I found the listing which data ppoData returnswhen called by different actions. The one i was actually missing was the GetObject function of the vault. I had everything but to get an object of an ID. And ironically I found that function 5 minutes after I wrote the question post...
    Like • Show 0 Likes0
    Actions
  - Brian Dalton @ Jeff Sweeney on Feb 16, 2012 6:57 PM
    Mark Correct
    Correct Answer
    This could be very helpful - if the file ID is persistent. I have been working on a macro that stores info about files in a spreadsheet for later retrieval, and so far I've been storing the path. That could be fragile if the file were moved...
    
    So, if I stored the ID of the file instead, could I be certain that it would not change even if the file was moved to a different location within the vault? How about if the file was renamed?
    
    Just how persistent is the File ID?
    Like • Show 0 Likes0
    Actions
    - Wayne Matus @ Brian Dalton on Feb 16, 2012 7:39 PM
      Mark Correct
      Correct Answer
      The fileID is persistent. When a file is first added to the vault a record is added to the database documents table and one field in this record is the fileID. This fileID is a unique field in the documents table. No two files can have the same fileID. If a file is deleted, the record is not. There is just a Deleted field that indicates the file no longer exists in the vault. So if a file is deleted, you do not have to worry about some other file being assigned that fileID.
      Like • Show 0 Likes0
      Actions

How to get IEdmFile object in OnCmd routine (API question)

Outcomes

Related Content

Recommended Content