Classe CMFCFilterChunkValueImpl

Esta é uma classe que simplifica tanto a lógica de pares de blocos como a de valor de propriedades.

Sintaxe

class CMFCFilterChunkValueImpl : public ATL::IFilterChunkValue;

Membros

Construtores Públicos

Métodos Públicos

Métodos Protegidos

Observações

Para usar, basta criar uma classe CMFCFilterChunkValueImpl do tipo certo

Exemplo:

CMFCFilterChunkValueImpl chunk;

HR = Chunk. SetBoolValue(PKEY_IsAttachment, verdadeiro);

ou

HR = Chunk. SetFileTimeValue(PKEY_ItemDate, ftLastModified);

Hierarquia de herança

ATL::IFilterChunkValue

CMFCFilterChunkValueImpl

Requerimentos

Cabeçalho: afxwin.h

CMFCFilterChunkValueImpl::Clear

Limpa o ChunkValue.

void Clear();

Observações

CMFCFilterChunkValueImpl::CMFCFilterChunkValueImpl

Constrói o objeto.

CMFCFilterChunkValueImpl();

Observações

CMFCFilterChunkValueImpl::~CMFCFilterChunkValueImpl

Destrói o objeto.

virtual ~CMFCFilterChunkValueImpl();

Observações

CMFCFilterChunkValueImpl::CopyChunk

Copia este bloco para uma estrutura que descreve as características de um bloco.

HRESULT CopyChunk(STAT_CHUNK* pStatChunk);

Parâmetros

pStatChunk
Um apontador para o valor de destino que descreve as características do bloco.

Valor de retorno

S_OK se for bem-sucedido; caso contrário, um código de erro.

Observações

CMFCFilterChunkValueImpl::CopyFrom

Inicializa este valor de bloco a partir do outro valor.

void CopyFrom (IFilterChunkValue* pValue);

Parâmetros

pValor
Especifica o valor de origem a copiar.

Observações

CMFCFilterChunkValueImpl::GetChunkGUID

Recupera o GUID do bloco.

REFGUID GetChunkGUID() const;

Valor de retorno

Uma referência a um GUID a identificar o bloco.

Observações

CMFCFilterChunkValueImpl::GetChunkPID

Recupera o PID (ID da propriedade) do bloco.

DWORD GetChunkPID() const;

Valor de retorno

Um valor DWORD contendo o ID da propriedade.

Observações

CMFCFilterChunkValueImpl::GetChunkType

Recupera o tipo chunk.

CHUNKSTATE GetChunkType() const;

Valor de retorno

Um valor enumerado CHUNKSTATE, que especifica se o bloco atual é uma propriedade do tipo texto ou uma propriedade do tipo valor.

Observações

CMFCFilterChunkValueImpl::GetString

Recupera o valor da cadeia.

CString &GetString();

Valor de retorno

Uma cadeia contendo o valor do bloco.

Observações

CMFCFilterChunkValueImpl::GetValue

Recupera o valor como propvariante alocado.

HRESULT GetValue(PROPVARIANT** ppPropVariant);

Parâmetros

ppPropVariant
Quando a função retorna, este parâmetro contém o valor do bloco.

Valor de retorno

S_OK se o PROPVARIANT fosse alocado com sucesso e o valor do chunk fosse copiado com sucesso para ppPropVariant; caso contrário, um código de erro.

Observações

CMFCFilterChunkValueImpl::GetValueNoAlloc

Devolve o valor não alocado (valor interno).

PROPVARIANT GetValueNoAlloc ();

Valor de retorno

Devolve o valor atual do bloco.

Observações

CMFCFilterChunkValueImpl::IsValid

Verifica se o valor deste imóvel é válido ou não.

BOOL IsValid() const;

Valor de retorno

TRUE se o valor atual do chunk for válido; caso contrário, FALSO.

Observações

CMFCFilterChunkValueImpl::SetBoolValue

Sobrecarregado. Define a propriedade por chave para um Booleano.

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

pkey
Especifica uma chave de propriedade.

bVal
Especifica o valor do chunk a definir.

ChunkType
As bandeiras indicam se este bloco contém uma propriedade de tipo texto ou de tipo valor. Os valores de bandeira são retirados da enumeração CHUNKSTATE.

localidade
A língua e a sublíngua associadas a um pedaço de texto. A localização de blocos é usada pelos indexadores de documentos para realizar a quebra correta de palavras do texto. Se o bloco não for nem de tipo texto nem de tipo de valor com tipo de dado VT_LPWSTR, VT_LPSTR ou VT_BSTR, este campo é ignorado.

cwcLenSource
O comprimento em caracteres do texto de origem do qual o segmento atual foi derivado. Um valor zero indica correspondência carácter a carácter entre o texto de origem e o texto derivado. Um valor não nulo significa que não existe tal correspondência direta.

cwcStartSource
O deslocamento a partir do qual o texto de origem para um bloco derivado começa no bloco de origem.

chunkBreakType
O tipo de quebra que separa o bloco anterior do atual. Os valores provêm da enumeração CHUNK_BREAKTYPE.

Valor de retorno

S_OK se for bem-sucedido; caso contrário, um código de erro.

Observações

CMFCFilterChunkValueImpl::SetChunk

Uma função auxiliar que define as propriedades comuns do bloco.

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

pkey
Especifica uma chave de propriedade.

ChunkType
As bandeiras indicam se este bloco contém uma propriedade de tipo texto ou de tipo valor. Os valores de bandeira são retirados da enumeração CHUNKSTATE.

localidade
A língua e a sublíngua associadas a um pedaço de texto. A localização de blocos é usada pelos indexadores de documentos para realizar a quebra correta de palavras do texto. Se o bloco não for nem de tipo texto nem de tipo de valor com tipo de dado VT_LPWSTR, VT_LPSTR ou VT_BSTR, este campo é ignorado.

cwcLenSource
O comprimento em caracteres do texto de origem do qual o segmento atual foi derivado. Um valor zero indica correspondência carácter a carácter entre o texto de origem e o texto derivado. Um valor não nulo significa que não existe tal correspondência direta.

cwcStartSource
O deslocamento a partir do qual o texto de origem para um bloco derivado começa no bloco de origem.

chunkBreakType
O tipo de quebra que separa o bloco anterior do atual. Os valores provêm da enumeração CHUNK_BREAKTYPE.

Valor de retorno

S_OK se for bem-sucedido; caso contrário, código de erro.

Observações

CMFCFilterChunkValueImpl::SetDwordValue

Define a propriedade por chave para 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

pkey
Especifica uma chave de propriedade.

dwVal
Especifica o valor do chunk a definir.

ChunkType
As bandeiras indicam se este bloco contém uma propriedade de tipo texto ou de tipo valor. Os valores de bandeira são retirados da enumeração CHUNKSTATE.

localidade
A língua e a sublíngua associadas a um pedaço de texto. A localização de blocos é usada pelos indexadores de documentos para realizar a quebra correta de palavras do texto. Se o bloco não for nem de tipo texto nem de tipo de valor com tipo de dado VT_LPWSTR, VT_LPSTR ou VT_BSTR, este campo é ignorado.

cwcLenSource
O comprimento em caracteres do texto de origem do qual o segmento atual foi derivado. Um valor zero indica correspondência carácter a carácter entre o texto de origem e o texto derivado. Um valor não nulo significa que não existe tal correspondência direta.

cwcStartSource
O deslocamento a partir do qual o texto de origem para um bloco derivado começa no bloco de origem.

chunkBreakType
O tipo de quebra que separa o bloco anterior do atual. Os valores provêm da enumeração CHUNK_BREAKTYPE.

Valor de retorno

S_OK se for bem-sucedido; caso contrário, um código de erro.

Observações

CMFCFilterChunkValueImpl::SetFileTimeTimeValue

Defina a propriedade por chave para um tempo de ficheiro.

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

pkey
Especifica uma chave de propriedade.

dtVal
Especifica o valor do chunk a definir.

ChunkType
As bandeiras indicam se este bloco contém uma propriedade de tipo texto ou de tipo valor. Os valores de bandeira são retirados da enumeração CHUNKSTATE.

localidade
A língua e a sublíngua associadas a um pedaço de texto. A localização de blocos é usada pelos indexadores de documentos para realizar a quebra correta de palavras do texto. Se o bloco não for nem de tipo texto nem de tipo de valor com tipo de dado VT_LPWSTR, VT_LPSTR ou VT_BSTR, este campo é ignorado.

cwcLenSource
O comprimento em caracteres do texto de origem do qual o segmento atual foi derivado. Um valor zero indica correspondência carácter a carácter entre o texto de origem e o texto derivado. Um valor não nulo significa que não existe tal correspondência direta.

cwcStartSource
O deslocamento a partir do qual o texto de origem para um bloco derivado começa no bloco de origem.

chunkBreakType
O tipo de quebra que separa o bloco anterior do atual. Os valores provêm da enumeração CHUNK_BREAKTYPE.

Valor de retorno

S_OK se for bem-sucedido; caso contrário, um código de erro.

Observações

CMFCFilterChunkValueImpl::SetInt64Value

Defina a propriedade por chave para 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

pkey
Especifica uma chave de propriedade.

nVal
Especifica o valor do chunk a definir.

ChunkType
As bandeiras indicam se este bloco contém uma propriedade de tipo texto ou de tipo valor. Os valores de bandeira são retirados da enumeração CHUNKSTATE.

localidade
A língua e a sublíngua associadas a um pedaço de texto. A localização de blocos é usada pelos indexadores de documentos para realizar a quebra correta de palavras do texto. Se o bloco não for nem de tipo texto nem de tipo de valor com tipo de dado VT_LPWSTR, VT_LPSTR ou VT_BSTR, este campo é ignorado.

cwcLenSource
O comprimento em caracteres do texto de origem do qual o segmento atual foi derivado. Um valor zero indica correspondência carácter a carácter entre o texto de origem e o texto derivado. Um valor não nulo significa que não existe tal correspondência direta.

cwcStartSource
O deslocamento a partir do qual o texto de origem para um bloco derivado começa no bloco de origem.

chunkBreakType
O tipo de quebra que separa o bloco anterior do atual. Os valores provêm da enumeração CHUNK_BREAKTYPE.

Valor de retorno

S_OK se for bem-sucedido; caso contrário, um código de erro.

Observações

CMFCFilterChunkValueImpl::SetIntValue

Defina a propriedade por chave para 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

pkey
Especifica uma chave de propriedade.

nVal
Especifica o valor do chunk a definir.

ChunkType
As bandeiras indicam se este bloco contém uma propriedade de tipo texto ou de tipo valor. Os valores de bandeira são retirados da enumeração CHUNKSTATE.

localidade
A língua e a sublíngua associadas a um pedaço de texto. A localização de blocos é usada pelos indexadores de documentos para realizar a quebra correta de palavras do texto. Se o bloco não for nem de tipo texto nem de tipo de valor com tipo de dado VT_LPWSTR, VT_LPSTR ou VT_BSTR, este campo é ignorado.

cwcLenSource
O comprimento em caracteres do texto de origem do qual o segmento atual foi derivado. Um valor zero indica correspondência carácter a carácter entre o texto de origem e o texto derivado. Um valor não nulo significa que não existe tal correspondência direta.

cwcStartSource
O deslocamento a partir do qual o texto de origem para um bloco derivado começa no bloco de origem.

chunkBreakType
O tipo de quebra que separa o bloco anterior do atual. Os valores provêm da enumeração CHUNK_BREAKTYPE.

Valor de retorno

S_OK se for bem-sucedido; caso contrário, um código de erro.

Observações

CMFCFilterChunkValueImpl::SetLongValue

Defina a propriedade por chave para 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

pkey
Especifica uma chave de propriedade.

LVal
Especifica o valor do chunk a definir.

ChunkType
As bandeiras indicam se este bloco contém uma propriedade de tipo texto ou de tipo valor. Os valores de bandeira são retirados da enumeração CHUNKSTATE.

localidade
A língua e a sublíngua associadas a um pedaço de texto. A localização de blocos é usada pelos indexadores de documentos para realizar a quebra correta de palavras do texto. Se o bloco não for nem de tipo texto nem de tipo de valor com tipo de dado VT_LPWSTR, VT_LPSTR ou VT_BSTR, este campo é ignorado.

cwcLenSource
O comprimento em caracteres do texto de origem do qual o segmento atual foi derivado. Um valor zero indica correspondência carácter a carácter entre o texto de origem e o texto derivado. Um valor não nulo significa que não existe tal correspondência direta.

cwcStartSource
O deslocamento a partir do qual o texto de origem para um bloco derivado começa no bloco de origem.

chunkBreakType
O tipo de quebra que separa o bloco anterior do atual. Os valores provêm da enumeração CHUNK_BREAKTYPE.

Valor de retorno

S_OK se for bem-sucedido; caso contrário, um código de erro.

Observações

CMFCFilterChunkValueImpl::SetSystemTimeTimeValue

Define a propriedade por chave para 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

pkey
Especifica uma chave de propriedade.

systemTime
Especifica o valor do chunk a definir.

ChunkType
As bandeiras indicam se este bloco contém uma propriedade de tipo texto ou de tipo valor. Os valores de bandeira são retirados da enumeração CHUNKSTATE.

localidade
A língua e a sublíngua associadas a um pedaço de texto. A localização de blocos é usada pelos indexadores de documentos para realizar a quebra correta de palavras do texto. Se o bloco não for nem de tipo texto nem de tipo de valor com tipo de dado VT_LPWSTR, VT_LPSTR ou VT_BSTR, este campo é ignorado.

cwcLenSource
O comprimento em caracteres do texto de origem do qual o segmento atual foi derivado. Um valor zero indica correspondência carácter a carácter entre o texto de origem e o texto derivado. Um valor não nulo significa que não existe tal correspondência direta.

cwcStartSource
O deslocamento a partir do qual o texto de origem para um bloco derivado começa no bloco de origem.

chunkBreakType
O tipo de quebra que separa o bloco anterior do atual. Os valores provêm da enumeração CHUNK_BREAKTYPE.

Valor de retorno

S_OK se for bem-sucedido; caso contrário, um código de erro.

Observações

CMFCFilterChunkValueImpl::SetTextValue

Define a propriedade por chave para uma cadeia 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

pkey
Especifica uma chave de propriedade.

pszValue
Especifica o valor do chunk a definir.

ChunkType
As bandeiras indicam se este bloco contém uma propriedade de tipo texto ou de tipo valor. Os valores de bandeira são retirados da enumeração CHUNKSTATE.

localidade
A língua e a sublíngua associadas a um pedaço de texto. A localização de blocos é usada pelos indexadores de documentos para realizar a quebra correta de palavras do texto. Se o bloco não for nem de tipo texto nem de tipo de valor com tipo de dado VT_LPWSTR, VT_LPSTR ou VT_BSTR, este campo é ignorado.

cwcLenSource
O comprimento em caracteres do texto de origem do qual o segmento atual foi derivado. Um valor zero indica correspondência carácter a carácter entre o texto de origem e o texto derivado. Um valor não nulo significa que não existe tal correspondência direta.

cwcStartSource
O deslocamento a partir do qual o texto de origem para um bloco derivado começa no bloco de origem.

chunkBreakType
O tipo de quebra que separa o bloco anterior do atual. Os valores provêm da enumeração CHUNK_BREAKTYPE.

Valor de retorno

S_OK se for bem-sucedido; caso contrário, um código de erro.

Observações

Consulte também

Classes