CMFCFilterChunkValueImpl Class
Essa é uma classe que simplifica a lógica de par de valor de partes e de propriedade.
Sintaxe
class CMFCFilterChunkValueImpl : public ATL::IFilterChunkValue;
Membros
Construtores públicos
Nome | Descrição |
---|---|
CMFCFilterChunkValueImpl::~CMFCFilterChunkValueImpl | Destrói o objeto. |
CMFCFilterChunkValueImpl::CMFCFilterChunkValueImpl | Constrói o objeto . |
Métodos públicos
Nome | Descrição |
---|---|
CMFCFilterChunkValueImpl::Clear | Limpa o ChunkValue. |
CMFCFilterChunkValueImpl::CopyChunk | Copia essa parte para uma estrutura que descreve as características de uma parte. |
CMFCFilterChunkValueImpl::CopyFrom | Inicializa esse valor de parte a partir de outro valor. |
CMFCFilterChunkValueImpl::GetChunkGUID | Recupera o GUID da parte. |
CMFCFilterChunkValueImpl::GetChunkPID | Recupera o PID da parte (ID da propriedade). |
CMFCFilterChunkValueImpl::GetChunkType | Obtém o tipo de parte. |
CMFCFilterChunkValueImpl::GetString | Recupera o valor de cadeia de caracteres. |
CMFCFilterChunkValueImpl::GetValue | Recupera o valor como um propvariant alocado. |
CMFCFilterChunkValueImpl::GetValueNoAlloc | Retorna o valor não alocado (valor interno). |
CMFCFilterChunkValueImpl::IsValid | Verifica se esse valor de propriedade é válido ou não. |
CMFCFilterChunkValueImpl::SetBoolValue | Sobrecarregado. Define a propriedade por chave como um booliano. |
CMFCFilterChunkValueImpl::SetDwordValue | Define a propriedade por chave como um dword. |
CMFCFilterChunkValueImpl::SetFileTimeValue | Define a propriedade por chave como um filetime. |
CMFCFilterChunkValueImpl::SetInt64Value | Define a propriedade por chave como um int64. |
CMFCFilterChunkValueImpl::SetIntValue | Define a propriedade por chave como um int. |
CMFCFilterChunkValueImpl::SetLongValue | Define a propriedade por chave como um LONG. |
CMFCFilterChunkValueImpl::SetSystemTimeValue | Define a propriedade por chave como um SystemTime. |
CMFCFilterChunkValueImpl::SetTextValue | Define a propriedade por chave como uma cadeia de caracteres Unicode. |
Métodos protegidos
Nome | Descrição |
---|---|
CMFCFilterChunkValueImpl::SetChunk | Uma função auxiliar que define as propriedades comuns da parte. |
Comentários
Para usar, basta criar uma classe CMFCFilterChunkValueImpl de tipo certo
Exemplo:
CMFCFilterChunkValueImpl chunk;
hr = chunk.SetBoolValue(PKEY_IsAttachment, true);
or
hr = chunk.SetFileTimeValue(PKEY_ItemDate, ftLastModified);
Hierarquia de herança
ATL::IFilterChunkValue
Requisitos
Cabeçalho: afxwin.h
CMFCFilterChunkValueImpl::Clear
Limpa o ChunkValue.
void Clear();
Comentários
CMFCFilterChunkValueImpl::CMFCFilterChunkValueImpl
Constrói o objeto .
CMFCFilterChunkValueImpl();
Comentários
CMFCFilterChunkValueImpl::~CMFCFilterChunkValueImpl
Destrói o objeto.
virtual ~CMFCFilterChunkValueImpl();
Comentários
CMFCFilterChunkValueImpl::CopyChunk
Copia essa parte para uma estrutura que descreve as características de uma parte.
HRESULT CopyChunk(STAT_CHUNK* pStatChunk);
Parâmetros
pStatChunk
Um ponteiro para o valor de destino que descreve as características da parte.
Valor de retorno
S_OK se for bem-sucedido, caso contrário, um código de erro.
Comentários
CMFCFilterChunkValueImpl::CopyFrom
Inicializa esse valor de parte a partir de outro valor.
void CopyFrom (IFilterChunkValue* pValue);
Parâmetros
pValue
Especifica o valor da fonte do qual copiar.
Comentários
CMFCFilterChunkValueImpl::GetChunkGUID
Recupera o GUID da parte.
REFGUID GetChunkGUID() const;
Valor de retorno
Uma referência a um GUID que identifica a parte.
Comentários
CMFCFilterChunkValueImpl::GetChunkPID
Recupera o PID da parte (ID da propriedade).
DWORD GetChunkPID() const;
Valor de retorno
Um valor DWORD que contém a ID da propriedade.
Comentários
CMFCFilterChunkValueImpl::GetChunkType
Recupera o tipo da parte.
CHUNKSTATE GetChunkType() const;
Valor de retorno
Um valor enumerado CHUNKSTATE, que especifica se a parte atual é uma propriedade de tipo de texto ou uma propriedade de tipo de valor.
Comentários
CMFCFilterChunkValueImpl::GetString
Recupera o valor de cadeia de caracteres.
CString &GetString();
Valor de retorno
Uma cadeia de caracteres que contém o valor da parte.
Comentários
CMFCFilterChunkValueImpl::GetValue
Recupera o valor como um propvariant alocado.
HRESULT GetValue(PROPVARIANT** ppPropVariant);
Parâmetros
ppPropVariant
Quando a função retorna, esse parâmetro contém o valor da parte.
Valor de retorno
S_OK se PROPVARIANT foi alocado com êxito e o valor da parte foi copiado com êxito para ppPropVariant, caso contrário, um código de erro.
Comentários
CMFCFilterChunkValueImpl::GetValueNoAlloc
Retorna o valor não alocado (valor interno).
PROPVARIANT GetValueNoAlloc ();
Valor de retorno
Retorna o valor atual da parte.
Comentários
CMFCFilterChunkValueImpl::IsValid
Verifica se esse valor de propriedade é válido ou não.
BOOL IsValid() const;
Valor de retorno
TRUE se o valor da parte atual for válido, caso contrário, FALSE.
Comentários
CMFCFilterChunkValueImpl::SetBoolValue
Sobrecarregado. Define a propriedade por chave como um booliano.
HRESULT SetBoolValue(
REFPROPERTYKEY pkey,
BOOL bVal,
CHUNKSTATE chunkType = CHUNK_VALUE,
LCID locale = 0,
DWORD cwcLenSource = 0,
DWORD cwcStartSource = 0,
CHUNK_BREAKTYPE chunkBreakType = CHUNK_NO_BREAK);
HRESULT SetBoolValue(
REFPROPERTYKEY pkey,
VARIANT_BOOL bVal,
CHUNKSTATE chunkType = CHUNK_VALUE,
LCID locale = 0,
DWORD cwcLenSource = 0,
DWORD cwcStartSource = 0,
CHUNK_BREAKTYPE chunkBreakType = CHUNK_NO_BREAK);
Parâmetros
chave
Especifica uma chave de propriedade.
bVal
Especifica o valor de parte a ser definido.
chunkType
Os sinalizadores indicam se essa parte contém uma propriedade de tipo de texto ou de valor. Os valores de sinalizador são obtidos da enumeração CHUNKSTATE.
locale
A linguagem e a sublinguagem associadas a uma parte de texto. A localidade da parte é usada por indexadores de documentos para executar a quebra de texto de palavra adequada. Se a parte não for do tipo de texto nem de um tipo de valor com tipo de dados VT_LPWSTR, VT_LPSTR ou VT_BSTR, esse campo será ignorado.
cwcLenSource
O comprimento em caracteres do texto de origem do qual a parte atual foi derivada. Um valor zero significa correspondência de caractere por caractere entre o texto de origem e o texto derivado. Um valor diferente de zero significa que essa correspondência direta não existe.
cwcStartSource
O deslocamento do qual o texto de origem de uma parte derivada começa na parte de origem.
chunkBreakType
O tipo de quebra que separa a parte anterior da parte atual. Os valores são da enumeração CHUNK_BREAKTYPE.
Valor de retorno
S_OK se for bem-sucedido, caso contrário, um código de erro.
Comentários
CMFCFilterChunkValueImpl::SetChunk
Uma função auxiliar que define as propriedades comuns da parte.
HRESULT SetChunk(
REFPROPERTYKEY pkey,
CHUNKSTATE chunkType=CHUNK_VALUE,
LCID locale=0,
DWORD cwcLenSource=0,
DWORD cwcStartSource=0,
CHUNK_BREAKTYPE chunkBreakType=CHUNK_NO_BREAK);
Parâmetros
chave
Especifica uma chave de propriedade.
chunkType
Os sinalizadores indicam se essa parte contém uma propriedade de tipo de texto ou de valor. Os valores de sinalizador são obtidos da enumeração CHUNKSTATE.
locale
A linguagem e a sublinguagem associadas a uma parte de texto. A localidade da parte é usada por indexadores de documentos para executar a quebra de texto de palavra adequada. Se a parte não for do tipo de texto nem de um tipo de valor com tipo de dados VT_LPWSTR, VT_LPSTR ou VT_BSTR, esse campo será ignorado.
cwcLenSource
O comprimento em caracteres do texto de origem do qual a parte atual foi derivada. Um valor zero significa correspondência de caractere por caractere entre o texto de origem e o texto derivado. Um valor diferente de zero significa que essa correspondência direta não existe.
cwcStartSource
O deslocamento do qual o texto de origem de uma parte derivada começa na parte de origem.
chunkBreakType
O tipo de quebra que separa a parte anterior da parte atual. Os valores são da enumeração CHUNK_BREAKTYPE.
Valor de retorno
S_OK se for bem-sucedido, caso contrário, código de erro.
Comentários
CMFCFilterChunkValueImpl::SetDwordValue
Definir a propriedade por chave como um dword.
HRESULT SetDwordValue(
REFPROPERTYKEY pkey,
DWORD dwVal,
CHUNKSTATE chunkType = CHUNK_VALUE,
LCID locale = 0,
DWORD cwcLenSource = 0,
DWORD cwcStartSource = 0,
CHUNK_BREAKTYPE chunkBreakType = CHUNK_NO_BREAK);
Parâmetros
chave
Especifica uma chave de propriedade.
dwVal
Especifica o valor de parte a ser definido.
chunkType
Os sinalizadores indicam se essa parte contém uma propriedade de tipo de texto ou de valor. Os valores de sinalizador são obtidos da enumeração CHUNKSTATE.
locale
A linguagem e a sublinguagem associadas a uma parte de texto. A localidade da parte é usada por indexadores de documentos para executar a quebra de texto de palavra adequada. Se a parte não for do tipo de texto nem de um tipo de valor com tipo de dados VT_LPWSTR, VT_LPSTR ou VT_BSTR, esse campo será ignorado.
cwcLenSource
O comprimento em caracteres do texto de origem do qual a parte atual foi derivada. Um valor zero significa correspondência de caractere por caractere entre o texto de origem e o texto derivado. Um valor diferente de zero significa que essa correspondência direta não existe.
cwcStartSource
O deslocamento do qual o texto de origem de uma parte derivada começa na parte de origem.
chunkBreakType
O tipo de quebra que separa a parte anterior da parte atual. Os valores são da enumeração CHUNK_BREAKTYPE.
Valor de retorno
S_OK se for bem-sucedido, caso contrário, um código de erro.
Comentários
CMFCFilterChunkValueImpl::SetFileTimeValue
Definir a propriedade por chave como um filetime.
HRESULT SetFileTimeValue(
REFPROPERTYKEY pkey,
FILETIME dtVal,
CHUNKSTATE chunkType = CHUNK_VALUE,
LCID locale = 0,
DWORD cwcLenSource = 0,
DWORD cwcStartSource = 0,
CHUNK_BREAKTYPE chunkBreakType = CHUNK_NO_BREAK);
Parâmetros
chave
Especifica uma chave de propriedade.
dtVal
Especifica o valor de parte a ser definido.
chunkType
Os sinalizadores indicam se essa parte contém uma propriedade de tipo de texto ou de valor. Os valores de sinalizador são obtidos da enumeração CHUNKSTATE.
locale
A linguagem e a sublinguagem associadas a uma parte de texto. A localidade da parte é usada por indexadores de documentos para executar a quebra de texto de palavra adequada. Se a parte não for do tipo de texto nem de um tipo de valor com tipo de dados VT_LPWSTR, VT_LPSTR ou VT_BSTR, esse campo será ignorado.
cwcLenSource
O comprimento em caracteres do texto de origem do qual a parte atual foi derivada. Um valor zero significa correspondência de caractere por caractere entre o texto de origem e o texto derivado. Um valor diferente de zero significa que essa correspondência direta não existe.
cwcStartSource
O deslocamento do qual o texto de origem de uma parte derivada começa na parte de origem.
chunkBreakType
O tipo de quebra que separa a parte anterior da parte atual. Os valores são da enumeração CHUNK_BREAKTYPE.
Valor de retorno
S_OK se for bem-sucedido, caso contrário, um código de erro.
Comentários
CMFCFilterChunkValueImpl::SetInt64Value
Definir a propriedade por chave como um int64.
HRESULT SetInt64Value(
REFPROPERTYKEY pkey,
__int64 nVal,
CHUNKSTATE chunkType = CHUNK_VALUE,
LCID locale = 0,
DWORD cwcLenSource = 0,
DWORD cwcStartSource = 0,
CHUNK_BREAKTYPE chunkBreakType = CHUNK_NO_BREAK);
Parâmetros
chave
Especifica uma chave de propriedade.
nVal
Especifica o valor de parte a ser definido.
chunkType
Os sinalizadores indicam se essa parte contém uma propriedade de tipo de texto ou de valor. Os valores de sinalizador são obtidos da enumeração CHUNKSTATE.
locale
A linguagem e a sublinguagem associadas a uma parte de texto. A localidade da parte é usada por indexadores de documentos para executar a quebra de texto de palavra adequada. Se a parte não for do tipo de texto nem de um tipo de valor com tipo de dados VT_LPWSTR, VT_LPSTR ou VT_BSTR, esse campo será ignorado.
cwcLenSource
O comprimento em caracteres do texto de origem do qual a parte atual foi derivada. Um valor zero significa correspondência de caractere por caractere entre o texto de origem e o texto derivado. Um valor diferente de zero significa que essa correspondência direta não existe.
cwcStartSource
O deslocamento do qual o texto de origem de uma parte derivada começa na parte de origem.
chunkBreakType
O tipo de quebra que separa a parte anterior da parte atual. Os valores são da enumeração CHUNK_BREAKTYPE.
Valor de retorno
S_OK se for bem-sucedido, caso contrário, um código de erro.
Comentários
CMFCFilterChunkValueImpl::SetIntValue
Definir a propriedade por chave como um int.
HRESULT SetIntValue(
REFPROPERTYKEY pkey,
int nVal,
CHUNKSTATE chunkType = CHUNK_VALUE,
LCID locale = 0,
DWORD cwcLenSource = 0,
DWORD cwcStartSource = 0,
CHUNK_BREAKTYPE chunkBreakType = CHUNK_NO_BREAK);
Parâmetros
chave
Especifica uma chave de propriedade.
nVal
Especifica o valor de parte a ser definido.
chunkType
Os sinalizadores indicam se essa parte contém uma propriedade de tipo de texto ou de valor. Os valores de sinalizador são obtidos da enumeração CHUNKSTATE.
locale
A linguagem e a sublinguagem associadas a uma parte de texto. A localidade da parte é usada por indexadores de documentos para executar a quebra de texto de palavra adequada. Se a parte não for do tipo de texto nem de um tipo de valor com tipo de dados VT_LPWSTR, VT_LPSTR ou VT_BSTR, esse campo será ignorado.
cwcLenSource
O comprimento em caracteres do texto de origem do qual a parte atual foi derivada. Um valor zero significa correspondência de caractere por caractere entre o texto de origem e o texto derivado. Um valor diferente de zero significa que essa correspondência direta não existe.
cwcStartSource
O deslocamento do qual o texto de origem de uma parte derivada começa na parte de origem.
chunkBreakType
O tipo de quebra que separa a parte anterior da parte atual. Os valores são da enumeração CHUNK_BREAKTYPE.
Valor de retorno
S_OK se for bem-sucedido, caso contrário, um código de erro.
Comentários
CMFCFilterChunkValueImpl::SetLongValue
Definir a propriedade por chave como um LONG.
HRESULT SetLongValue(
REFPROPERTYKEY pkey,
long lVal,
CHUNKSTATE chunkType = CHUNK_VALUE,
LCID locale = 0,
DWORD cwcLenSource = 0,
DWORD cwcStartSource = 0,
CHUNK_BREAKTYPE chunkBreakType = CHUNK_NO_BREAK);
Parâmetros
chave
Especifica uma chave de propriedade.
lVal
Especifica o valor de parte a ser definido.
chunkType
Os sinalizadores indicam se essa parte contém uma propriedade de tipo de texto ou de valor. Os valores de sinalizador são obtidos da enumeração CHUNKSTATE.
locale
A linguagem e a sublinguagem associadas a uma parte de texto. A localidade da parte é usada por indexadores de documentos para executar a quebra de texto de palavra adequada. Se a parte não for do tipo de texto nem de um tipo de valor com tipo de dados VT_LPWSTR, VT_LPSTR ou VT_BSTR, esse campo será ignorado.
cwcLenSource
O comprimento em caracteres do texto de origem do qual a parte atual foi derivada. Um valor zero significa correspondência de caractere por caractere entre o texto de origem e o texto derivado. Um valor diferente de zero significa que essa correspondência direta não existe.
cwcStartSource
O deslocamento do qual o texto de origem de uma parte derivada começa na parte de origem.
chunkBreakType
O tipo de quebra que separa a parte anterior da parte atual. Os valores são da enumeração CHUNK_BREAKTYPE.
Valor de retorno
S_OK se for bem-sucedido, caso contrário, um código de erro.
Comentários
CMFCFilterChunkValueImpl::SetSystemTimeValue
Define a propriedade por chave como um SystemTime.
HRESULT SetSystemTimeValue(
REFPROPERTYKEY pkey,
const SYSTEMTIME& systemTime,
CHUNKSTATE chunkType = CHUNK_VALUE,
LCID locale=0,
DWORD cwcLenSource=0,
DWORD cwcStartSource=0,
CHUNK_BREAKTYPE chunkBreakType=CHUNK_NO_BREAK);
Parâmetros
chave
Especifica uma chave de propriedade.
systemTime
Especifica o valor de parte a ser definido.
chunkType
Os sinalizadores indicam se essa parte contém uma propriedade de tipo de texto ou de valor. Os valores de sinalizador são obtidos da enumeração CHUNKSTATE.
locale
A linguagem e a sublinguagem associadas a uma parte de texto. A localidade da parte é usada por indexadores de documentos para executar a quebra de texto de palavra adequada. Se a parte não for do tipo de texto nem de um tipo de valor com tipo de dados VT_LPWSTR, VT_LPSTR ou VT_BSTR, esse campo será ignorado.
cwcLenSource
O comprimento em caracteres do texto de origem do qual a parte atual foi derivada. Um valor zero significa correspondência de caractere por caractere entre o texto de origem e o texto derivado. Um valor diferente de zero significa que essa correspondência direta não existe.
cwcStartSource
O deslocamento do qual o texto de origem de uma parte derivada começa na parte de origem.
chunkBreakType
O tipo de quebra que separa a parte anterior da parte atual. Os valores são da enumeração CHUNK_BREAKTYPE.
Valor de retorno
S_OK se for bem-sucedido, caso contrário, um código de erro.
Comentários
CMFCFilterChunkValueImpl::SetTextValue
Define a propriedade por chave como uma cadeia de caracteres Unicode.
HRESULT SetTextValue(
REFPROPERTYKEY pkey,
LPCTSTR pszValue,
CHUNKSTATE chunkType = CHUNK_VALUE,
LCID locale = 0,
DWORD cwcLenSource = 0,
DWORD cwcStartSource = 0,
CHUNK_BREAKTYPE chunkBreakType = CHUNK_NO_BREAK);
Parâmetros
chave
Especifica uma chave de propriedade.
pszValue
Especifica o valor de parte a ser definido.
chunkType
Os sinalizadores indicam se essa parte contém uma propriedade de tipo de texto ou de valor. Os valores de sinalizador são obtidos da enumeração CHUNKSTATE.
locale
A linguagem e a sublinguagem associadas a uma parte de texto. A localidade da parte é usada por indexadores de documentos para executar a quebra de texto de palavra adequada. Se a parte não for do tipo de texto nem de um tipo de valor com tipo de dados VT_LPWSTR, VT_LPSTR ou VT_BSTR, esse campo será ignorado.
cwcLenSource
O comprimento em caracteres do texto de origem do qual a parte atual foi derivada. Um valor zero significa correspondência de caractere por caractere entre o texto de origem e o texto derivado. Um valor diferente de zero significa que essa correspondência direta não existe.
cwcStartSource
O deslocamento do qual o texto de origem de uma parte derivada começa na parte de origem.
chunkBreakType
O tipo de quebra que separa a parte anterior da parte atual. Os valores são da enumeração CHUNK_BREAKTYPE.
Valor de retorno
S_OK se for bem-sucedido, caso contrário, um código de erro.