IServerClient::GetGroupContacts method

---

Receives array of user contacts assigned to specific group and returns the number of retrieved contacts.

HRESULT GetGroupContacts(
    LPSTR lpszGroupName,
    WORD * lpwGroupContactsCount,
    LPDWORD lpdwExtendedCode
);

Parameters

lpszGroupName

[in] Pointer to a text buffer that contains the name of group of which contacts are retrieved.

lpwGroupContactsCount

[out] Pointer to a WORD variable that receives the number of retrieved user contacts.

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 received array of the contacts must be retrieved by subsequent call of IServerClient::EnumGroupContacts function.

Check GROUP_FLAG_HIDE_USERS flag if it is set in dwGroupFlags member of TRANSFER_GROUP_STRUCT. If the flag is set then it is unnecessary to call the function because it will always return an empty list.