~~NOTOC~~ [[server_api]] > [[BS2_SetUserPhraseHandler]] ---- ===== BS2_SetUserPhraseHandler ===== [+ 2.7.0] Registers the server user phrase handler. \\ ==== Declaration ==== #include "BS_API.h" int BS2_SetUserPhraseHandler(void* context, OnUserPhrase ptrQuery); ==== Parameter ==== * [In] ''//context//'' : Context * [In] ''//ptrQuery//'' : Callback function to ask for user phrase to the server after successful authentication **NOTE**\\ To use the server matching service, the [[configuration api#BS2DisplayConfig|BS2DisplayConfig]]'s queryUserPhrase should be set as true. ==== Return Value ==== If successfully done, ''BS_SDK_SUCCESS'' will be returned. \\ If there is an error, the corresponding error code will be returned. ==== See Also ==== [[BS2_ResponseUserPhrase]]