SOLIDWORKS PDM Professional API Help Send Feedback
GetSortedHistory Method (IEdmHistory3)
See Also 
EPDM.Interop.epdm Namespace > IEdmHistory3 Interface : GetSortedHistory Method (IEdmHistory3)


ppoRetHistory
Array of EdmHistoryItem structures; one structure for each history item (see Remarks)
lEdmHistoryTypes
Combination of EdmHistoryType bits; indicates the kinds of records to retrieve
Gets the history listing for the specified history types.

Syntax

Visual Basic 
Sub GetSortedHistory( _
   ByRef ppoRetHistory() As EdmHistoryItem, _
   Optional ByVal lEdmHistoryTypes As System.Integer _
) 
C# 
void GetSortedHistory( 
   out EdmHistoryItem[] ppoRetHistory,
   System.int lEdmHistoryTypes
)
C++/CLI 
void GetSortedHistory( 
&   [Out] array<EdmHistoryItem>^ ppoRetHistory,
&   System.int lEdmHistoryTypes
) 

Parameters

ppoRetHistory
Array of EdmHistoryItem structures; one structure for each history item (see Remarks)
lEdmHistoryTypes
Combination of EdmHistoryType bits; indicates the kinds of records to retrieve

Example

See the IEdmHistory3 examples.

Remarks

This method works in both Web 2 and thick client applications.

Call this method after calling IEdmHistory::AddFile and IEdmHistory::AddFolder.

The returned array of history items in ppoRetHistory is sorted with the most recent records at the beginning.

Call IEdmHistory3::GetEventDescription, passing one of the EdmHistoryItem structures returned by this method, to obtain its event description.

Return codes:

  • S_OK: The method successfully executed.
  • S_FALSE: One of the arguments is invalid.
 

See Also

Availability

SOLIDWORKS PDM Professional 2020