[Explorer API] Determine Document State

Question

I may be using the wrong terminology, but how can I determine the state of a document? In particular, I need to know if a doc is in the Work-in-Progress state. 
 There's a section in the Public SDK Help entitled Progress Control Flags . However, the section has no content. Where are those flags defined, and what API uses them?

Dan Williams · Accepted Answer

Jon Summers , 
 Yes, as I like to say, "words get in the way". 
 If you asking about what state a document is at in a workflow, you would select the document's properties into a buffer (static or dynamic) such as aaApi_SelectDocument(), and then examine the properties via the appropriate "get" function. 
 Take a look at the functions found here: 
 
 And the document properties that you can retrieve from this list: 
 
 And of course, if you are asking about something else, screenshots can be very helpful to identify what you are referring to if that is possible.

Dan Williams · Answer

You do it in a very similar way. You first select the state's properties into a buffer, and then examine the buffer. 
 Try something like this: 
 // with appropriate error handling, etc... 
 retCode = aaApi_SelectState(stateId); 
 // check retCode - see documentation 
 // get the property 
 thePropertyString = aaApi_GetStateStringProperty(STATE_PROP_NAME, 0);

Dan Williams · Answer

Jon Summers , 
 A second "look" at your posting made me think that perhaps you are more interested in the "progress control flags". Yes, finding things in the SDK help file can be a challenge at times. 
 Here's a "trick" that I use often when I can't find something that I know is in the documentation. 
 I fire up my favorite text search tool, i.e. Notepad++ and use the search files feature to search all the *.h and *.fdf files delivered with the SDK for words that I think are related to what I am looking for. 
 I searched like this: 
 
 Which returned this: 
 
 Which may be what you are asking about. 
 FWIW, the first "hit" in the search for "progress" like you show in your post returns this: 
 
 So, I would assume that the flags that you are asking about are related to these functions.

[Explorer API] Determine Document State

Top Replies