RetrieveRoster Method

This method will retrieve this entity's roster from the server.

Syntax

ANSI (Cross Platform)
int RetrieveRoster();

Unicode (Windows)
INT RetrieveRoster();
- (void)retrieveRoster;
#define MID_XMPP_RETRIEVEROSTER 16

IPWORKSMQ_EXTERNAL int IPWORKSMQ_CALL IPWorksMQ_XMPP_Do(void *lpObj, int methid, int cparam, void *param[], int cbparam[], int64 *lpllVal);

Remarks

After the class connects, it will automatically send a request to the server to retrieve the roster. However, should the user or application wish to update the entire roster, this method may be used to do so.

After a successful call to the RetrieveRoster method, the server will respond with this entity's roster. The class will parse the roster and fire the Sync event once per item. This event may also fire for each entity added to or removed from the roster.

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

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks MQ 2020 C++ Edition - Version 20.0 [Build 8155]