POOM操作:IContact、IItem、IPOutlookItemCollection、IPoutlookApp操作
一.基础知识
POOM是基于微软COM技术的一套针对手机上(PIM)个人信息管理的COM接口库。因此开发者除了熟悉Mobile开发的基本技术外,还必须对COM技术有一定了解和熟悉,知道基本COM使用方法即可。详细的COM知识请参考相关COM书籍。下面的概念我认为必须掌握:
1. COM的初始化、卸载
2. 接口查询、获得
3. COM中字符串操作
4. ISteam的使用(后续会在操作联系人照片时就会使用到)
二.POOM对象接口类介绍
POOM不仅包含了对联系人的操作,还包含了任务、约会提醒等关于个人信息管理的内容。从SDK中就能很清晰的看到诸如ITask, IContact, IAppointment各种COM对象接口。在本文主要介绍联系人相关的各类接口:
IPoutlookApp
所有POOM操作都必须首先通过它来的到对应的操作接口,在它的方法函数里比较有用的是GetItemFromOid,这个函数能通过OID(唯一标示),就可以到底对应的对象接口,下面我们可以看到它的应用。在WM5上有了升级版IPoutlookApp2。
OID(唯一标示):在WM系统上是可以唯一表示一条记录的符号,即我们熟悉的一条联系人,一个约会信息,它们在系统中有一个唯一的标示,不会改变,它们都存储在系统的数据库中。
IFolder
POOM中Contacts, Tasks, Appointments对象是以文件夹概念的形式存在。所以需要通过它来访问我们需要ITask, IContact, IAppointment对象接口。好比我们有一个风景照片的文件夹,里面包含了都是风景照文件,我们还有一个人物类的文件夹,里面包含了都是人物的照片。我们会用到它的get_items方法函数。
IPOutlookItemCollection
为了进一步访问对象接口IContact,还必须从IFolder中得到每一条记录的集合,通过集合来最终访问每一个记录。
IItem
指的就是在PIM中通常的一条记录。每条记录都是可以通过IItem对象接口的方式来方法,它不区分类别(Task, Contact, Appointment都一样对待),下文会有详细介绍。
IContact
专门处理联系人信息的对象接口,本文就主要通过它来处理联系人数据。在这里我要指出(也许是我没发现),在WM5版本后又提供了10左右的新的内容,但是在此对象接口中并没有提供,但是可以IItem来处理。
简要提下另外几个对象接口
ITask:如果需要处理任务信息,就使用它(没具体使用过)
IAppointment:在处理约会信息时,使用它,配合IRecurrencePattern就可以处理约会时的周期信息了。
三.如何使用POOM
1.初始化及打开POOM
POOM是基于COM技术,因此必须使用CoInitializeEx来初始化COM对象。在使用完POOM后不要忘记调用CoUninitialize()来卸载。
在初始化COM后,就可以来使用COM的一些基本接口函数了。通过CoCreateInstance来得到POOM应用对象,得到后还必须登入POOM-建立与POOM系统的一个对话过程,因此当使用完或者不在需要本次POOM相关操作后,就需要退出这次会话过程
HRESULT hr;
IPOutlookApp * m_polApp;
if (SUCCEEDED(CoInitializeEx( NULL, 0))) //初始化COM
{
// 得到IPOutlookApp对象
if(SUCCEEDED(CoCreateInstance(CLSID_Application,NULL, CLSCTX_INPROC_SERVER,
IID_IPOutlookApp, reinterpret_cast<void **>(&m_polApp)))){
if(FAILED(m_polApp->Logon(NULL))) { //建立一次会话
If(m_polApp)
m_polApp->Release();
return FALSE; }
}else
return FALSE;
}
……………….
……………….
If(m_polApp){
m_polApp->Logoff(); 结束会话
m_polApp->Release(); 释放
m_polApp = NULL;
}
CoUninitialize(); //释放COM
2.获得某一类(Contact)信息
本文主要讨论的是POOM的Contact联系人内容,所以这里以Contact的内容来展示POOM具体操作,当然你可以操作Task或者Appointment。
在打开POOM后接下去如何操作呢?
首先必须选择需要进行什么类型操作,是联系人呢?还是任务、约会提醒?就如上面提到我们需要选择一个文件夹,通过它来进入我们的具体类型操作。可以通过GetDefaultFolder方法来得到某一文件夹。
接着继续调用get_Items方法得到一个IPOutlookItemCollection集合接口:
m_pFolder->get_Items(&m_pItems)
通过集合接口可以得到文件夹中包含了多少条记录,说通俗点就是有多少个联系人、任务,约会。查看文档你会发现还包含了许多有用的方法:查询,排序等。对于简单的操作最有用的就是包含了多少条信息。
下面是完整代码:
if(SUCCEEDED(m_polApp->GetDefaultFolder(olFolderContacts, &m_pFolder)))
if(SUCCEEDED (m_pFolder->get_Items(&m_pItems)))
if(SUCCEEDED (m_pItems->get_Count(&m_ItemCount)))
return TRUE;
3.进行IContact和IItem对象接口操作
a. IContact操作
读者可能等的有点不耐烦了,怎么还没有看到如何实实在在的得到联系人具体信息。现在就马上呈现。
通过IPOutlookItemCollection集合接口的Item方法来得到一个IContact对象接口。
if(FAILED(m_pItems->Item(index,reinterpret_cast<IDispatch **>(&pContact))))
{
return FALSE;
}
可以发现主要的参数是一个index的索引值,IPOutlookItemCollection集合以索引来定位某个具体的联系人记录。拥有了IContact接口就可以非常方便的来获取需要联系人信息了。删除记录可以使用IContact对象接口的delete方法。
在这里需要注意,如果删除了一条位于中间的记录,那么index值对应的记录就会发生变化,使之不对应。最好办法是从后面开始删除。
例如:
得到姓名:
BSTR pbstrbuf = NULL;
pContact->get_FirstName(&pbstrbuf);
pContact->get_MiddleName(&pbstrbuf);
pContact->get_LastName(&pbstrbuf);
得到手机号码:
pContact->get_MobileTelephoneNumber(&pbstrbuf);
得到生日:
DATE mdate
pContact->get_Birthday(&mdate);
在IContact文档里详细罗列了所有方法的内容
在这里请不要忘记了对COM字符串pbstrbuf内存的释放,请调用下面函数:
SysFreeString(pbstrbuf);
知道了如何得到信息,当然也要知道如何写入信息。使用IContact写入信息一样方便,只需调用put_×××方法就可以了。最后不要忘记保存调用:
pContact->Save();
如果忘了调用就白费功夫了。
b. IItem操作
如果读者手里拿着的WM5的手机,会发现在WM5上含有的“昵称,即时消息,公司电话”等信息,怎么在IContact没有找到对应的方法呢(如果哪位读者熟知并能找到,望请告诉本人,谢谢)?你问我为什么,我也只能说不知道。幸运的是还有IItem,不过不要忘了上文提到了IItem对象接口,POOM还提供了全面的IItem对象接口的方法。
IItem提供了完善的处理接口,但同时它的易用性就降低。IItem接口中提供了GetProps和SetProps其实是对PIM数据库操作的一种封装,如果你熟悉数据库操作,你会发现他们很像,如出一辙。请看如何使用GetProps来得到数据。
int dwlen =0;
HRESULT hr;
ULONG cbBuffer = 0;
CEPROPID rgPropId[1];
CEPROPVAL *buf=NULL;
HANDLE hHeap = GetProcessHeap();
rgPropId[0]= PIMPR_NICKNAME;
hr = pItem->GetProps(rgPropId, CEDB_ALLOWREALLOC , 1, &buf, &cbBuffer, hHeap);
if(FAILED(hr) || 0 == cbBuffer || buf == NULL)
return 0;
else
{ CEPROPVAL * ppropval = buf;
if(ppropval[0].wFlags!=CEDB_PROPNOTFOUND)
{
if(LOWORD(ppropval[0].propid) == CEVT_LPWSTR)
OutputDebugString(ppropval[0].val.lpwstr);
}
else
dwlen = 0;
LocalFree(buf);
HeapFree(hHeap, 0, buf);
}
读者看到这里可能比较头痛,怎么比IContact如此复杂的多。但是如果熟悉数据库操作,这些还是不难的。因为设计到一些数据库操作操作概念,这里我简单介绍下。
GetProps有两种模式一种是POOM自己分配内存,还有一种是调用者来提供内存的分配。这里我现在了前者,因此需要提供一个Heap句柄,使用GetProcessHeap来创建。
CEPROPID rgPropId[1]提供了调用者需要得到哪些内容,通过它来确定GetProps返回的是什么数据(例如,姓名、号码、地址等)。上述代码使用PIMPR_NICKNAME,取得昵称信息。CEDB_PROPNOTFOUND进行判断是否存在此信息,不要忽略这点,因为数据库格式决定了这种情况确实会发生,而不是给你一个空字符串。
相对于写入操作,IItem提供的SetProps方法就简单很多,只需给定数据,然后调用save保存就完成了。
CEPROPVAL rgPropval[1] = {0};
rgPropval[0].propid = PIMPR_NICKNAME;
rgPropval[0].val.lpwstr = _T(“JUN”);
hr = pItem->SetProps(0, 1, rgPropval);
if(SUCCEEDED(hr))
hr = pItem->Save();
c. 照片-特殊数据处理
在联系人信息里面有一个比较特殊的信息类型-stream类型数据。WM5提供了联系人照片功能,它的数据就是以stream方式保存如果熟悉数据库的读者会发现,实质它是Blob二进制方式存储与数据库,因为数据库中没有stream类型。在这里我们利用IItem的OpenProperty方法来进行照片的存储
HRESULT hr = E_FAIL;
IStream *pStream = NULL;
CEPROPID propid = PIMPR_PICTURE;
ULONG cbRead = 0;
if(SUCCEEDED(hr = pItem->OpenProperty(propid, GENERIC_READ, &pStream)))
{ hr = pStream->Read(pserial, buflen, &cbRead);
pStream->Release();}
if(SUCCEEDED(hr)) return cbRead;
相应的写入操作:
if(SUCCEEDED(hr = pItem->OpenProperty(propid, GENERIC_WRITE, &pStream)))
{hr = pStream->Write(pserial, buflen, &cbWritten);
if(SUCCEEDED(hr))
{ hr = pStream->Commit(0);
hr = pItem->Save();}
pStream->Release();}
}
上述代码中使用了IStream接口来读写数据,在写入后不要忘记调用IStream的Commit方法和IItem的Save方法保存数据。
4.OID的使用技巧
上文已经讲解了OID的概念,在POOM中OID是一个比较重要的概念,在很多接口中都会发现有get_Oid方法。因为Oid是唯一的标示,所以它是不变。因此利用这个特点我们可以保存它,而不会像内存地址一样下次运行时就失去意义了。在有些应用中当需要对再次访问过的记录进行操作(修改,删除)时,就不需要使用很傻的特定值搜索来进行定位了,可以直接使用刚才保存的OID来进行处理。
首先调用相应的get_Oid
LONG oid
IContact *pContact; //假设已经得到此接口
pContact ->get_Oid(&oid);
然后使之oid保存至有效的空间,当再此需要处理此记录时,但又得不到pContact接口时,就可以调用IPOutlookApp的GetItemFromOid方法来直接得到IContact:
IContact *pContact = NULL;
if(S_OK=m_polApp->GetItemFromOid(oid,reinterpret_cast<IDispatch **>(&pContact)))
{ …… }
5.后期处理-保存数据
按照上述处理,基本上可以得到所有的联系人信息。接下来可以使用File IO相关操作来保存数据至文件中,具体讨论不在本文范围内了。同样还原备份数据时,先File IO然后进行POOM操作,上面已经有详细的介绍。
四.结论
本文主要讲解了如何使用POOM和与联系人相关的对象接口来读取或者写入联系人的各种信息。希望本文读者能领悟到POOM的其它操作(Task和Appointment),如能对读者更深入的使用POOM起到抛砖引玉的作用,那就更好了。
时间仓促,再加上本人才疏学浅,在文中难免有错漏之处,欢迎朋友们指正。