Suporte do provedor para indicadores
O exemplo neste tópico adiciona a interface IRowsetLocate
à classe CCustomRowset
. Em quase todos os casos, você começa adicionando uma interface a um objeto COM existente. Em seguida, você pode testá-la adicionando mais chamadas dos modelos de consumidor. Este exemplo demonstra como:
Adicione uma interface a um provedor.
Determinar dinamicamente as colunas a serem retornadas ao consumidor.
Adicionar suporte a indicadores.
A interface IRowsetLocate
herda da interface IRowset
. Para adicionar a interface IRowsetLocate
, herde CCustomRowset
de IRowsetLocateImpl.
Adicionar a interface IRowsetLocate
é um pouco diferente da maioria das interfaces. Para fazer o alinhamento das VTABLEs, os modelos de provedor OLE DB têm um parâmetro de modelo para lidar com a interface derivada. O seguinte código mostra a nova lista de heranças:
////////////////////////////////////////////////////////////////////////
// CustomRS.h
// CCustomRowset
class CCustomRowset : public CRowsetImpl< CCustomRowset,
CTextData, CCustomCommand, CAtlArray<CTextData>,
CSimpleRow,
IRowsetLocateImpl<CCustomRowset, IRowsetLocate>>
O quarto, o quinto e o sexto parâmetros são todos adicionados. Este exemplo usa os padrões para o quarto e quinto parâmetros, mas especifica como IRowsetLocateImpl
o sexto parâmetro. IRowsetLocateImpl
é uma classe de modelo OLE DB que usa dois parâmetros de modelo: eles conectam a interface IRowsetLocate
à classe CCustomRowset
. Para adicionar a maioria das interfaces, você pode ignorar essa etapa e passar para a próxima. Somente as interfaces IRowsetLocate
e IRowsetScroll
precisam ser tratadas dessa forma.
Em seguida, você precisa informar a CCustomRowset
para chamar QueryInterface
para a interface IRowsetLocate
. Adicione a linha COM_INTERFACE_ENTRY(IRowsetLocate)
ao mapa. O mapa da interface de CCustomRowset
deve aparecer conforme mostrado no seguinte código:
////////////////////////////////////////////////////////////////////////
// CustomRS.h
typedef CRowsetImpl< CCustomRowset, CTextData, CCustomCommand, CAtlArray<CTextData>, CSimpleRow, IRowsetLocateImpl<CCustomRowset, IRowsetLocate>> _RowsetBaseClass;
BEGIN_COM_MAP(CCustomRowset)
COM_INTERFACE_ENTRY(IRowsetLocate)
COM_INTERFACE_ENTRY_CHAIN(_RowsetBaseClass)
END_COM_MAP()
Você também precisa conectar seu mapa à classe CRowsetImpl
. Adicione a macro COM_INTERFACE_ENTRY_CHAIN para conectar no mapa CRowsetImpl
. Além disso, crie um typedef chamado RowsetBaseClass
que consiste das informações de herança. Esse typedef é arbitrário e pode ser ignorado.
Por fim, manipule a chamada IColumnsInfo::GetColumnsInfo
. Normalmente, você usaria as macros PROVIDER_COLUMN_ENTRY para fazer isso. No entanto, um consumidor pode querer usar indicadores. Você precisa ser capaz de alterar as colunas que o provedor retorna dependendo de o consumidor solicitar ou não um indicador.
Para manipular a chamada IColumnsInfo::GetColumnsInfo
, exclua o mapa de PROVIDER_COLUMN na classe CTextData
. A macro PROVIDER_COLUMN_MAP define uma função GetColumnInfo
. Defina sua função GetColumnInfo
. A declaração de função deve ter esta aparência:
////////////////////////////////////////////////////////////////////////
// CustomRS.H
class CTextData
{
...
// NOTE: Be sure you removed the PROVIDER_COLUMN_MAP!
static ATLCOLUMNINFO* GetColumnInfo(CCustomRowset* pThis,
ULONG* pcCols);
static ATLCOLUMNINFO* GetColumnInfo(CCustomCommand* pThis,
ULONG* pcCols);
...
};
Em seguida, implemente a função GetColumnInfo
no arquivo CustomRS.cpp da seguinte maneira:
////////////////////////////////////////////////////////////////////
// CustomRS.cpp
template <class TInterface>
ATLCOLUMNINFO* CommonGetColInfo(IUnknown* pPropsUnk, ULONG* pcCols)
{
static ATLCOLUMNINFO _rgColumns[5];
ULONG ulCols = 0;
CComQIPtr<TInterface> spProps = pPropsUnk;
CDBPropIDSet set(DBPROPSET_ROWSET);
set.AddPropertyID(DBPROP_BOOKMARKS);
DBPROPSET* pPropSet = NULL;
ULONG ulPropSet = 0;
HRESULT hr;
if (spProps)
hr = spProps->GetProperties(1, &set, &ulPropSet, &pPropSet);
// Check the property flag for bookmarks, if it is set, set the
// zero ordinal entry in the column map with the bookmark
// information.
if (pPropSet)
{
CComVariant var = pPropSet->rgProperties[0].vValue;
CoTaskMemFree(pPropSet->rgProperties);
CoTaskMemFree(pPropSet);
if ((SUCCEEDED(hr) && (var.boolVal == VARIANT_TRUE)))
{
ADD_COLUMN_ENTRY_EX(ulCols, OLESTR("Bookmark"), 0,
sizeof(DWORD), DBTYPE_BYTES,
0, 0, GUID_NULL, CAgentMan, dwBookmark,
DBCOLUMNFLAGS_ISBOOKMARK)
ulCols++;
}
}
// Next set the other columns up.
ADD_COLUMN_ENTRY_EX(ulCols, OLESTR("Field1"), 1, 16, DBTYPE_STR,
0xFF, 0xFF, GUID_NULL, CTextData, szField1)
ulCols++;
ADD_COLUMN_ENTRY_EX(ulCols, OLESTR("Field2"), 2, 16, DBTYPE_STR,
0xFF, 0xFF, GUID_NULL, CTextData, szField2)
ulCols++;
if (pcCols != NULL)
*pcCols = ulCols;
return _rgColumns;
}
ATLCOLUMNINFO* CTextData::GetColumnInfo(CCustomCommand* pThis,
ULONG* pcCols)
{
return CommonGetColInfo<ICommandProperties>(pThis->GetUnknown(),
pcCols);
}
ATLCOLUMNINFO* CAgentMan::GetColumnInfo(RUpdateRowset* pThis, ULONG* pcCols)
{
return CommonGetColInfo<IRowsetInfo>(pThis->GetUnknown(), pcCols);
}
GetColumnInfo
primeiro verifica se uma propriedade chamada DBPROP_IRowsetLocate
está definida. O OLE DB tem propriedades para cada uma das interfaces opcionais fora do objeto de conjunto de linhas. Se o consumidor quiser usar uma dessas interfaces opcionais, ele definirá uma propriedade como true. Em seguida, o provedor pode verificar essa propriedade e tomar medidas especiais com base nela.
Em sua implementação, você obtém a propriedade usando o ponteiro para o objeto de comando. O ponteiro pThis
representa o conjunto de linhas ou a classe de comando. Como você usa modelos aqui, você precisa passar isso como um ponteiro void
ou o código não é compilado.
Especifique uma matriz estática para conter as informações da coluna. Se o consumidor não quiser a coluna de indicador, uma entrada na matriz será desperdiçada. Você pode alocar dinamicamente essa matriz, mas precisaria destruí-la corretamente. Este exemplo define e usa as macros ADD_COLUMN_ENTRY e ADD_COLUMN_ENTRY_EX para inserir as informações na matriz. Você pode adicionar as macros ao arquivo CustomRS.H, conforme mostrado no seguinte código:
////////////////////////////////////////////////////////////////////////
// CustomRS.h
#define ADD_COLUMN_ENTRY(ulCols, name, ordinal, colSize, type, precision, scale, guid, dataClass, member) \
_rgColumns[ulCols].pwszName = (LPOLESTR)name; \
_rgColumns[ulCols].pTypeInfo = (ITypeInfo*)NULL; \
_rgColumns[ulCols].iOrdinal = (ULONG)ordinal; \
_rgColumns[ulCols].dwFlags = 0; \
_rgColumns[ulCols].ulColumnSize = (ULONG)colSize; \
_rgColumns[ulCols].wType = (DBTYPE)type; \
_rgColumns[ulCols].bPrecision = (BYTE)precision; \
_rgColumns[ulCols].bScale = (BYTE)scale; \
_rgColumns[ulCols].cbOffset = offsetof(dataClass, member);
#define ADD_COLUMN_ENTRY_EX(ulCols, name, ordinal, colSize, type, precision, scale, guid, dataClass, member, flags) \
_rgColumns[ulCols].pwszName = (LPOLESTR)name; \
_rgColumns[ulCols].pTypeInfo = (ITypeInfo*)NULL; \
_rgColumns[ulCols].iOrdinal = (ULONG)ordinal; \
_rgColumns[ulCols].dwFlags = flags; \
_rgColumns[ulCols].ulColumnSize = (ULONG)colSize; \
_rgColumns[ulCols].wType = (DBTYPE)type; \
_rgColumns[ulCols].bPrecision = (BYTE)precision; \
_rgColumns[ulCols].bScale = (BYTE)scale; \
_rgColumns[ulCols].cbOffset = offsetof(dataClass, member); \
memset(&(_rgColumns[ulCols].columnid), 0, sizeof(DBID)); \
_rgColumns[ulCols].columnid.uName.pwszName = (LPOLESTR)name;
Para testar o código no consumidor, você precisa fazer algumas alterações no manipulador OnRun
. A primeira alteração na função é que você adiciona código para adicionar uma propriedade ao conjunto de propriedades. O código define a propriedade DBPROP_IRowsetLocate
como true, informando ao provedor que você deseja a coluna de indicador. O código do manipulador OnRun
deve aparecer da seguinte maneira:
//////////////////////////////////////////////////////////////////////
// TestProv Consumer Application in TestProvDlg.cpp
void CTestProvDlg::OnRun()
{
CCommand<CAccessor<CProvider>> table;
CDataSource source;
CSession session;
if (source.Open("Custom.Custom.1", NULL, NULL, NULL,
NULL) != S_OK)
return;
if (session.Open(source) != S_OK)
return;
CDBPropSet propset(DBPROPSET_ROWSET);
propset.AddProperty(DBPROP_IRowsetLocate, true);
if (table.Open(session, _T("c:\\public\\testprf2\\myData.txt"),
&propset) != S_OK)
return;
CBookmark<4> tempBookmark;
ULONG ulCount=0;
while (table.MoveNext() == S_OK)
{
DBCOMPARE compare;
if (ulCount == 2)
tempBookmark = table.bookmark;
HRESULT hr = table.Compare(table.dwBookmark, table.dwBookmark,
&compare);
if (FAILED(hr))
ATLTRACE(_T("Compare failed: 0x%X\n"), hr);
else
_ASSERTE(compare == DBCOMPARE_EQ);
m_ctlString1.AddString(table.szField1);
m_ctlString2.AddString(table.szField2);
ulCount++;
}
table.MoveToBookmark(tempBookmark);
m_ctlString1.AddString(table.szField1);
m_ctlString2.AddString(table.szField2);
}
O loop while
contém código para chamar o método Compare
na interface IRowsetLocate
. O código que você tem sempre deve passar porque você está comparando exatamente os mesmos indicadores. Além disso, armazene um indicador em uma variável temporária para que você possa usá-lo após a conclusão do loop while
para chamar a função MoveToBookmark
nos modelos de consumidor. A função MoveToBookmark
chama o método GetRowsAt
em IRowsetLocate
.
Você também precisa atualizar o registro de usuário no consumidor. Adicione uma entrada na classe para manipular um indicador e uma entrada no COLUMN_MAP:
///////////////////////////////////////////////////////////////////////
// TestProvDlg.cpp
class CProvider
{
// Attributes
public:
CBookmark<4> bookmark; // Add this line
char szCommand[16];
char szText[256];
// Binding Maps
BEGIN_ACCESSOR_MAP(CProvider, 1)
BEGIN_ACCESSOR(0, true) // auto accessor
BOOKMARK_ENTRY(bookmark) // Add this line
COLUMN_ENTRY(1, szField1)
COLUMN_ENTRY(2, szField2)
END_ACCESSOR()
END_ACCESSOR_MAP()
};
Após atualizar o código, você deverá ser capaz de compilar e executar o provedor com a interface IRowsetLocate
.