SAWSSDK::getFileHistory

Description

Retrieves history information of a file.

Syntax

int getFileHistory(
        String strRemoteFileFullName,
        StringArray aryUsers,
        int dwActionType,
        boolean bIncludeAnyComments,
        String strCommentSubString,
        HistoryOrderByArray aryHistoryOrderBy,
        BaseDataObject bdobPinned,
        HistoryArray aryFileHistoryInfo,
        BaseDataObject bdobCanceled,
        BaseDataObject bdostrError,
        Calendar dateFrom,
        Calendar dateTo
);

Parameters

strRemoteFileFullName
[in] Specifies the full name of the server file.

aryUsers
[in] Restricts the history report to the changes made by specified user.

dwActionType
[in] Restricts the history report to the specified actions.

bIncludeAnyComments
[in] Restricts the history report to the files that have any comments for the 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 columns.

bdobPinned
[out] Returns whether the file is pinned.

aryFileHistoryInfo
[out] Returns the history information set of the file.

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/time when the history information to begin at.

dateTo
[in] Specifies the date/time when the history information to end at.

Return Value

If the method succeeds, returns 0. If the method fails, returns other error codes.

See Also

• HistoryOrderByArray Class Array
• HistoryArray Class Array