Share via

IOlkAccount::GetAccountInfo

  • Article

Gets the type and categories information for the specified account.

Quick Info

See IOlkAccount.

HRESULT IOlkAccount::GetAccountInfo(  
    CLSID *pclsidType, 
    DWORD *pcCategories, 
    CLSID **prgclsidCategory 
);

Parameters

  • pclsidType
    [out] The class identifier for the account type. The value must be one of the following:

    • CLSID_OlkPOP3Account

    • CLSID_OlkIMAP4Account

    • CLSID_OlkMAPIAccount

    • CLSID_OlkHotmailAccount

    • CLSID_OlkLDAPAccount

  • pcCategories
    [out] The number of categories in prgclsidCategory.

  • prgclsidCategory
    [out] An array of categories that this account is associated with. The array is of size *pcCategories. The value of each category in the array must be one of the following:

    • CLSID_OlkMail

    • CLSID_OlkAddressBook

    • CLSID_OlkStore

Return Values

S_OK if the call succeeded; otherwise, an error code.

Remarks

After this method returns, you must free prgclsidCategory by using IOlkAccount::FreeMemory.

IOlkAccount::GetAccountInfo does not support the address book category for an Exchange account. If the account is an Exchange account (pclsidType is CLSID_OlkMAPIAccount), and the account implements the address book, calling IOlkAccount::GetAccountInfo will not return CLSID_OlkAddressBook as a category in prgclsidCategory.

See also

Constants (Account Management API)
IOlkAccount::FreeMemory