IServerClient::EnumGroups method

---

Retrieves the array of messaging groups received from the IM server.

HRESULT EnumGroups(
    LPDWORD lpTransferGroupsArray,
    LPDWORD lpdwExtendedCode
);

Parameters

lpTransferGroupsArray

[out] Pointer to an array of TRANSFER_GROUP_STRUCT structure that receives assigned groups.

lpdwExtendedCode

[out] Pointer to a DWORD variable that gets an extended code if error result is returned. For available codes see Available Extended Codes topic.

Return Value

S_OK

The function was successful.

E_INVALIDARG

One or more arguments are incorrect.

E_FAIL

Some error occurred in the function. Check lpdwExtendedCode variable to get extended information on the error.

Remarks

The size of the array pointed by the lpGroupsArray member must be equal to the number of groups returned by previous call of IServerClient::GetGroups function.