EOS_KWS_UpdateParentEmail

EOS API reference page for EOS_KWS_UpdateParentEmail

3 mins to read

This function is part of the KWS Interface.

Remarks

This interface is not available for general access at this time. Update the parent contact information for a given local Product User ID

Return Value

  • EOS_Success if contact information update completes successfully

  • EOS_InvalidParameters if any of the options are incorrect

  • EOS_TooManyRequests if the number of allowed requests is exceeded

Parameters

EOS_KWS_UpdateParentEmail

Parameter Type And NameUsage Information
EOS_HKWS Handle
const EOS_KWS_UpdateParentEmailOptions* Optionsoptions required for updating the contact information such as the new email address
void* ClientDataArbitrary data that is passed back to you in the CompletionDelegate
const EOS_KWS_OnUpdateParentEmailCallback CompletionDelegateA callback that is fired when the operation completes, either successfully or in error

Callback Function Information

Because this function is asynchronous, it employs a callback of type EOS_KWS_OnUpdateParentEmailCallback to report the results of its operation.

Callback Remarks

Function prototype definition for callbacks passed to EOS_KWS_UpdateParentEmail

Callback Parameters

EOS_KWS_OnUpdateParentEmailCallback

Parameter Type And NameUsage Information
const EOS_KWS_UpdateParentEmailCallbackInfo* DataA EOS_KWS_UpdateParentEmailCallbackInfo containing the output information and result