DeleteClient Method

Deletes a client from the user list.

Syntax

• C++
• Objective-C
• C

ANSI (Cross Platform)
int DeleteClient(const char* lpszUserId);

Unicode (Windows)
INT DeleteClient(LPCWSTR lpszUserId);

- (void)deleteClient:(NSString*)userId;

#define MID_SHAREFILE_DELETECLIENT 13

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

Remarks

Deletes a client from the user list. Must call ListUsers before the User* properties will be updated. UserId is the id for the user that is going to be deleted.

// Deletes the first user.
shareFile.ListUsers();
string UserId = shareFile.Users[0].Id;
shareFile.DeleteClient(UserId);

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.)