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

SAWHSDK::unpinFile

Description

Unpins a file that has been pinned.

Syntax

int unpinFile(
       String strFileFullNameToUnpin,
      BaseDataObject bdostrUnpinnedFileFullName,
      BaseDataObject bdobCanceled,
        BaseDataProject bdostrError
);

Parameters

strFileFullNameToUnpin
[in] Specifies the full name of file to be unpinned.

bdostrUnpinnedFileFullName
[out] Returns the full name of the pinned 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.