SAWHSDK::pinFile
Description
Pins a file.
Syntax
int pinFile(
String strFileFullNameToPin,
int iVersionNumber,
BaseDataObject
bdostrPinnedFileFullName,
BaseDataObject bdobCandeled,
BaseDataProject bdostrError
);
Parameters
strFileFullNameToPin
[in] Specifies the full name of the file to be pinned.
iVersionNumber
[in] Specifies the version number of the file version to be pinned.
bdostrPinnedFileFullName
[out] Returns the full name of the file after it is pinned.
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.