online source control
back to content
sign up free version control plan

SAWHSDK::getFileGeneralInfo

Description

Retrieves the general information of a file.

Syntax

int getFileGeneralInfo(
        String strRemoteFileFullName,
        BaseDataObject
bdobMergeable,
        BaseDataObject
bdolRemoteVersion,
        Calendar
timeLatestModified,
        BaseDataObject bdoiRemoteSize,
        BaseDataObject
bdostrComment,
        BaseDataObject
bdobCanceled,
        BaseDataObject
bdostrError
);

Parameters

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

bdobMergeable
[out] Returns whether the file is mergeable.

bdoiRemoteVersion
[out] Returns the number of versions of the file on the server.

timeLatestModified
[out] Returns the last modification date/time of the file on the server.

bdoiRemoteSize
[out] Returns the size of the file on the server.

bdostrComment
[out] Returns the comments 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.

Return Value

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