Users.UpdateUserExternalID Method

UsersUpdateUserExternalID Method

A Sandcastle Documented Class Library

This function will update a user's External User ID. Once this is done, the old UserExternalID will no longer be recognized

Namespace: WCFAPI
Assembly: WCFAPI (in WCFAPI.dll) Version: 4.0.0.0 (4.0.0.0)

Syntax

C++

Copy

public ApiResults UpdateUserExternalID(
	string apiUsername,
	string apiPassword,
	string UserExternalID,
	string NewExternalID
)

Public Function UpdateUserExternalID ( 
	apiUsername As String,
	apiPassword As String,
	UserExternalID As String,
	NewExternalID As String
) As ApiResults

public:
virtual ApiResults^ UpdateUserExternalID(
	String^ apiUsername, 
	String^ apiPassword, 
	String^ UserExternalID, 
	String^ NewExternalID
) sealed

abstract UpdateUserExternalID : 
        apiUsername : string * 
        apiPassword : string * 
        UserExternalID : string * 
        NewExternalID : string -> ApiResults 
override UpdateUserExternalID : 
        apiUsername : string * 
        apiPassword : string * 
        UserExternalID : string * 
        NewExternalID : string -> ApiResults

Parameters

apiUsername: Type: SystemString
API Username
apiPassword: Type: SystemString
API Password
UserExternalID: Type: SystemString
Old External ID of the user to change
NewExternalID: Type: SystemString
New External ID for the user

Return Value

Type: ApiResults

[Missing <returns> documentation for "M:WCFAPI.Users.UpdateUserExternalID(System.String,System.String,System.String,System.String)"]

Reference

Users Class

WCFAPI Namespace