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

SAWHSDK::labelFiles

Description

Labels multiple files.

Syntax

int labelFiles(
        StringArray aryLabeledFiles,
        long[] aryVersionNumber,
        String strLabelName,
        String strComment,
        BaseDataObject bdobCanceled,
        BaseDataObject bdostrError
);

Parameters

aryLabeledFiles
[in] Specifies the full names of files to be labeled.

aryVersionNumber
[in] Specifies the version numbers of the files to be labeled.

strLabelName
[in] Specifies the name of the label.

strComment
[in] Specifies the comment for the label action.

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.