UpdateClient Method

Updates a client's information.

Syntax

• C++
• Objective-C
• C

ANSI (Cross Platform)
int UpdateClient(const char* lpszUserId, const char* lpszFirstName, const char* lpszLastName, const char* lpszEmail, const char* lpszCompany);

Unicode (Windows)
INT UpdateClient(LPCWSTR lpszUserId, LPCWSTR lpszFirstName, LPCWSTR lpszLastName, LPCWSTR lpszEmail, LPCWSTR lpszCompany);

- (void)updateClient:(NSString*)userId :(NSString*)firstName :(NSString*)lastName :(NSString*)email :(NSString*)company;

#define MID_SHAREFILE_UPDATECLIENT 34

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

Remarks

Updates a clients first name, last name, email, and/or company. UserId represents the string Id for the client that will be updated. FirstName, LastName, Email, and Company each represents the update value for their corresponding ShareFileUser* properties.

Passing an empty string for FirstName, LastName, Email, or Company will mean that the field will not be updated.

// Creates a client named FirstName Brown, with the email example@example.com with no company.
string userId = shareFile.CreateClient("FirstName", "Brown", "example@example.com", "");

// Updates the First name of the client to John and sets a company, leave everything else the same.
shareFile.UpdateClient(userId, "John", "", "", "nsoftware");

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