IPWorks Cloud 2020 C++ Edition

Questions / Feedback?

LockFile Method

Locks a file resource.

Syntax

ANSI (Cross Platform)
int LockFile(const char* lpszFileId, const char* lpszExpiration, int bAllowDownloading);

Unicode (Windows)
INT LockFile(LPCWSTR lpszFileId, LPCWSTR lpszExpiration, BOOL bAllowDownloading);
- (void)lockFile:(NSString*)fileId :(NSString*)expiration :(BOOL)allowDownloading;
#define MID_BOX_LOCKFILE 19

IPWORKSCLOUD_EXTERNAL int IPWORKSCLOUD_CALL IPWorksCloud_Box_Do(void *lpObj, int methid, int cparam, void *param[], int cbparam[], int64 *lpllVal);

Remarks

This method locks the file resource specified by FileId to prevent others from modifying it.

Expiration may be set to an appropriately-formatted timestamp to specify an expiration time for the file lock. If Expiration is empty, the file lock will never expire. Timestamps are formatted according to RFC 3339.

AllowDownloading specifies whether others should still be allowed to download the file while it's locked.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks Cloud 2020 C++ Edition - Version 20.0 [Build 8265]