SAWHSDK::getProjectHistoryByItem
Description
Retrieves the history information of a project by item.
Syntax
int getProjectHistoryByItem(
String strProjectFullName,
boolean bRecursive,
StringArray aryUser,
StringArray aryFileExtensions,
StringArray aryFileSubStrings,
int iActionType,
boolean bIncludeAnyComments,
String strCommentSubString,
HistoryOrderByArray
aryFilterHistorySortOrderBy,
HistoryArray
aryProjectHistoryInfo,
BaseDataObject bdobCanceled,
BaseDataObject bdostrError,
Calendar dateFrom,
Calendar dateTo
);
Parameters
strProjectFullName
[in] Specifies the full name of the project.
bRecursive
[in] Specifies whether to get history of the project recursively.
aryUser
[in] Restricts the history report to the changes made by
specified user.
aryFileExtensions
[in] Restricts the history report to the files with the specified file
extensions.
aryFileSubStrings
[in] Restricts the history report to the files whose names match the
specified substrings.
iActionType
[in] Restricts the history report to the specified actions.
bIncludeAnyComments
[in] Restricts the history report to the items that have any comments
for actions.
strCommentSubString
[in] Restricts the history report to the items that have any comments
that match the specified substrings.
aryFilterHistorySortOrderBy
[in] Sorts the history report by the specified column.
aryProjectHistoryInfo
[out] Returns the history report of the project.
bdobCanceled
[out] If the method fails, returns whether the operation is canceled.
bdostrError
[out] Returns the description of the result. If the operation succeeds, returns
'Completed'. If the operation fails, returns the error information.
dateFrom
[in] Specifies the date the history report to begin at.
dateTo
[in] Specifies the date the history report to end at.
Return Value
If the method succeeds, returns 0. If the method fails, returns other error codes.
See Also