Compartilhar via

Função de retorno de chamada PFNCOMPROPSHEET (compstui.h)

  • Artigo

A função ComPropSheet é fornecida pelo CPSUI e pode ser chamada por aplicativos CPSUI (incluindo DLLs de interface de impressora) para criar páginas de folha de propriedades.

Sintaxe

PFNCOMPROPSHEET Pfncompropsheet;

LONG_PTR Pfncompropsheet(
  [in] HANDLE hComPropSheet,
  [in] UINT Function,
  [in] LPARAM lParam1,
  [in] LPARAM lParam2
)
{...}

Parâmetros

[in] hComPropSheet

Identificador fornecido pelo chamador para um pai do grupo de folhas de propriedades. Para obter mais informações, consulte a seção Comentários a seguir.

[in] Function

Códigos de função ComPropSheet com prefixo CPSFUNC_ fornecidos pelo chamador especificando a operação a ser executada pela função ComPropSheet . Consulte a tabela de códigos de função ComPropSheet na seção Comentários abaixo.

[in] lParam1

Valor fornecido pelo chamador que depende do código da função ComPropSheet fornecido para Function.

[in] lParam2

Valor fornecido pelo chamador que depende do código da função ComPropSheet fornecido para Function.

Retornar valor

O valor retornado depende do código de função ComPropSheet fornecido para Function.

Comentários

Quando o CPSUI chama uma das funções do tipo PFNPROPSHEETUI de um aplicativo, ele passa um ponteiro para a função ComPropSheet em uma estrutura PROPSHEETUI_INFO . Uma função do tipo PFNPROPSHEETUI pode chamar a função ComPropSheet para descrever páginas de folha de propriedades para CPSUI.

Uma DLL de interface de impressora pode chamar ComPropSheet de dentro de sua função DrvDocumentPropertySheets ou sua função DrvDevicePropertySheets .

Os plug-ins de interface do usuário para drivers Unidrv e Pscript da Microsoft podem chamar ComPropSheet de dentro de seus métodos IPrintOemUI::D ocumentPropertySheets e IPrintOemUI::D evicePropertySheets .

O identificador pai do grupo especificado para o parâmetro hComPropSheet pode ser um dos seguintes:

  • O identificador recebido no membro hComPropSheet de uma estrutura PROPSHEETUI_INFO .

  • O identificador recebido como resultado de chamar ComPropSheet anteriormente com um código de função CPSFUNC_INSERT_PSUIPAGE e especificar PSUIPAGEINSERT_GROUP_PARENT como o membro Type para uma estrutura de INSERTPSUIPAGE_INFO .

Códigos de função ComPropSheet

Os seguintes códigos de função podem ser passados para a função ComPropSheet do CPSUI:

CPSFUNC_ADD_HPROPSHEETPAGE

O código da função CPSFUNC_ADD_HPROPSHEETPAGE faz com que a função ComPropSheet adicione uma página de folha de propriedades que foi criada chamando a função CreatePropertySheetPage .

Parâmetros (CPSFUNC_ADD_HPROPSHEETPAGE)

  • hComPropSheet: identificador pai do grupo

  • Função: o chamador define esse parâmetro de código de função como CPSFUNC_ADD_HPROPSHEETPAGE quando chama ComPropSheet para adicionar uma página de folha de propriedades

  • lParam1: manipular para uma página de folha de propriedades, obtida chamando a função CreatePropertySheetPage

  • lParam2: não usado, deve ser zero

Valor retornado (CPSFUNC_ADD_HPROPSHEETPAGE)

Se a operação for bem-sucedida, o ComPropSheet retornará um identificador CPSUI para a página adicionada; caso contrário, retornará NULL.

CPSFUNC_ADD_PCOMPROPSHEETUI

O código da função CPSFUNC_ADD_PCOMPROPSHEETUI faz com que a função ComPropSheet adicione um conjunto de uma ou mais páginas de folha de propriedades descritas por uma estrutura COMPROPSHEETUI .

Parâmetros

  • hComPropSheet: identificador pai do grupo

  • Função: o chamador define esse parâmetro de código de função como CPSFUNC_ADD_PCOMPROPSHEETUI quando chama ComPropSheet para adicionar um conjunto de uma ou mais páginas de folha de propriedades

  • lParam1: ponteiro para uma estrutura COMPROPSHEETUI

  • lParam2: ponteiro para um local de 32 bits para receber o número de páginas adicionadas ou, se ocorrer uma falha, um código de erro prefixado por ERR_CPSUI

Retornar valor

Se a operação for bem-sucedida, o ComPropSheet retornará um identificador para o conjunto de páginas adicionadas; caso contrário, a função retornará NULL.

CPSFUNC_ADD_PFNPROPSHEETUI

O código da função CPSFUNC_ADD_PFNPROPSHEETUI faz com que a função ComPropSheet chame a função do tipo PFNPROPSHEETUI especificada, que deve adicionar um conjunto de uma ou mais páginas de folha de propriedades.

Parâmetros (CPSFUNC_ADD_PFNPROPSHEETUI)

  • hComPropSheet: identificador pai do grupo

  • Função: o chamador define esse parâmetro de código de função como CPSFUNC_ADD_PFNPROPSHEETUI quando chama ComPropSheet. Em seguida, o ComPropSheet chama a função do tipo PFNPROPSHEETUI especificada para adicionar um conjunto de uma ou mais páginas de folha de propriedades.

  • lParam1: ponteiro para uma função do tipo PFNPROPSHEETUI

  • lParam2: um valor de 32 bits que é passado para a função do tipo PFNPROPSHEETUI para seu parâmetro lParam

Valor retornado (CPSFUNC_ADD_PFNPROPSHEETUI)

Se a operação for bem-sucedida, o ComPropSheet retornará um identificador para o conjunto de páginas adicionadas; caso contrário, a função retornará NULL.

CPSFUNC_ADD_PROPSHEETPAGE

O código da função CPSFUNC_ADD_PROPSHEETPAGE faz com que a função ComPropSheet adicione o tipo de página de folha de propriedades descrita por uma estrutura PROPSHEETPAGE .

Parâmetros (CPSFUNC_ADD_PROPSHEETPAGE)

  • hComPropSheet: identificador pai do grupo

  • Função: o chamador define esse parâmetro de código de função como CPSFUNC_ADD_PROPSHEETPAGE quando chama ComPropSheet para adicionar o tipo de página de folha de propriedades descrita por uma estrutura PROPSHEETPAGE . A função ComPropSheet chama a função CreatePropertySheetPage e passa o endereço da estrutura PROPSHEETPAGE para criar a página.

  • lParam1: ponteiro para uma estrutura PROPSHEETPAGE

  • lParam2: não usado, deve ser zero

Valor retornado (CPSFUNC_ADD_PROPSHEETPAGE)

Se a operação for bem-sucedida, o ComPropSheet retornará um identificador CPSUI para a página adicionada; caso contrário, retornará NULL.

CPSFUNC_DELETE_HCOMPROPSHEET

O código da função CPSFUNC_DELETE_HCOMPROPSHEET faz com que a função ComPropSheet exclua um conjunto de páginas de folha de propriedades especificadas por um identificador CPSUI.

Parâmetros (CPSFUNC_DELETE_HCOMPROPSHEET)

  • hComPropSheet: identificador pai do grupo

  • Função: o chamador define esse parâmetro de código de função como CPSFUNC_DELETE_HCOMPROPSHEET quando chama ComPropSheet para excluir um conjunto de páginas de folha de propriedades

  • lParam1: identificador CPSUI que se refere ao conjunto de páginas a serem excluídas. Esse identificador deve ter sido obtido anteriormente por uma chamada para ComPropSheet com um dos seguintes códigos de função:

    • CPSFUNC_ADD_HPROPSHEETPAGE

    • CPSFUNC_ADD_PCOMPROPSHEETUI

    • CPSFUNC_ADD_PFNPROPSHEETUI

    • CPSFUNC_ADD_PROPSHEETPAGE

    • CPSFUNC_INSERT_PSUIPAGE

  • lParam2: não usado, deve ser zero

Valor retornado (CPSFUNC_DELETE_HCOMPROPSHEET)

A função ComPropSheet retorna o número de páginas de folha de propriedades que foram excluídas.

CPSFUNC_DO_APPLY_CPSUI

O código da função CPSFUNC_DO_APPLY_CPSUI faz com que a função ComPropSheet simule a entrega de uma mensagem de notificação PSN_APPLY.

O CPSUI responde ao código da função CPSFUNC_DO_APPLY_CPSUI fornecendo o motivo CPSUICB_REASON_APPLYNOW para a função de retorno de chamada tipada por _CPSUICALLBACK de um aplicativo.

Parâmetros (CPSFUNC_DO_APPLY_CPSUI)

  • hComPropSheet: identificador pai do grupo

  • Função: o chamador define esse parâmetro de código de função como CPSFUNC_DO_APPLY_CPSUI quando chama o ComPropSheet para simular a entrega de uma mensagem de notificação PSN_APPLY

  • lParam1: identificador CPSUI que aponta para um conjunto de uma ou mais páginas de folha de propriedades. Normalmente, esse identificador foi especificado anteriormente como o parâmetro lParam1 para ComPropSheet usando o código de função CPSFUNC_IGNORE_CPSUI_PSN_APPLY .

  • lParam2: esse parâmetro é qualquer combinação dos seguintes sinalizadores de bits:

    • APPLYCPSUI_NO_NEWDEF – defina esse sinalizador se você não quiser que os valores padrão atuais (usados para a operação Desfazer) sejam alterados. Desmarque esse sinalizador se quiser que os valores atuais de todas as opções se tornem os padrões usados para a operação Desfazer.

    • APPLYCPSUI_OK_CANCEL_BUTTON - Defina esse sinalizador se o usuário selecionou o botão OK ou Cancelar (ou se você quiser simular essa atividade). Desmarque esse sinalizador se o usuário tiver selecionado o botão Fechar ou Aplicar Agora (ou se você quiser simular essa atividade). Se o código estiver configurado para receber mensagens PSN_APPLY, o código deverá marcar o membro lParam da estrutura PSHNOTIFY. Se o membro for zero, esse bit deverá ser limpo.

Valor retornado (CPSFUNC_DO_APPLY_CPSUI)

Se a operação for bem-sucedida, a função ComPropSheet retornará um valor diferente de zero; caso contrário, retornará zero e as páginas especificadas ficarão ativas.

Se você usar o código da função CPSFUNC_IGNORE_CPSUI_PSN_APPLY para desabilitar o tratamento do CPSUI da mensagem de notificação PSN_APPLY, deverá usar o código da função CPSFUNC_DO_APPLY_CPSUI para simular a entrega da mensagem de PSN_APPLY. Caso contrário, as alterações do usuário em uma página de folha de propriedades não poderão ser obtidas.

CPSFUNC_GET_HPSUIPAGES

O código da função CPSFUNC_GET_HPSUIPAGES faz com que a função ComPropSheet retorne uma matriz de identificadores CPSUI que apontam para páginas de folha de propriedades. Esses identificadores identificam as páginas filho associadas ao identificador pai do grupo especificado.

Para usar esse código de função, siga estas etapas:

  • Chame ComPropSheet, especificando o código da função CPSFUNC_GET_PAGECOUNT , para obter o número de páginas filho associadas ao pai do grupo especificado.

  • Aloque memória local suficiente para conter uma estrutura HANDLE para cada página.

  • Chame ComPropSheet novamente, especificando o código de função CPSFUNC_GET_HPSUIPAGES e o endereço da memória alocada localmente, para obter uma matriz de estruturas HANDLE.

Parâmetros (CPSFUNC_GET_HPSUIPAGES)

  • hComPropSheet: identificador pai do grupo

  • Função: o chamador define esse parâmetro de código de função como CPSFUNC_GET_HPSUIPAGES quando chama o ComPropSheet para recuperar uma matriz de identificadores CPSUI

  • lParam1: ponteiro para uma matriz de estruturas HANDLE

  • lParam2: tamanho da matriz HANDLE apontada por lParam1

Valor retornado (CPSFUNC_GET_HPSUIPAGES)

A função ComPropSheet retorna o número de identificadores que o CPSUI coloca na matriz HANDLE.

CPSFUNC_GET_PAGECOUNT

O código da função CPSFUNC_GET_PAGECOUNT faz com que a função ComPropSheet retorne o número de páginas de folha de propriedades que são páginas filho do identificador pai do grupo especificado.

Parâmetros (CPSFUNC_GET_PAGECOUNT)

  • hComPropSheet: identificador pai do grupo

  • Função: o chamador define esse parâmetro de código de função como CPSFUNC_GET_PAGECOUNT quando chama ComPropSheet para retornar a contagem de páginas filho

  • lParam1: não usado, deve ser zero

  • lParam2: não usado, deve ser zero

Valor retornado (CPSFUNC_GET_PAGECOUNT)

A função ComPropSheet retorna o número de páginas contadas.

CPSFUNC_GET_PFNPROPSHEETUI_ICON

O código da função CPSFUNC_GET_PFNPROPSHEETUI_ICON faz com que a função ComPropSheet retorne um identificador para o ícone associado a um conjunto de páginas de folha de propriedades. O conjunto de páginas deve ter sido criado anteriormente por uma função do tipo PFNPROPSHEETUI.

A função ComPropSheet chama a função do tipo PFNPROPSHEETUI associada ao identificador de página especificado e passa um valor de motivo de PROPSHEETUI_REASON_GET_ICON. A função do tipo PFNPROPSHEETUI chama LoadImage e fornece o tamanho do ícone especificado bylParam2 para carregar um recurso de ícone.

Parâmetros (CPSFUNC_GET_PFNPROPSHEETUI_ICON)

  • hComPropSheet: identificador pai do grupo

  • Função: o chamador define esse parâmetro de código de função como CPSFUNC_GET_PFNPROPSHEETUI_ICON quando chama ComPropSheet para recuperar um identificador para o ícone associado a um conjunto de páginas de folha de propriedades

  • lParam1: identificador CPSUI que se refere a um conjunto de páginas de folha de propriedades. Esse identificador deve ter sido obtido anteriormente por uma chamada para ComPropSheet com o código de função CPSFUNC_ADD_PFNPROPSHEETUI .

  • lParam2: especifica dois valores do tamanho do WORD que representam o tamanho do ícone, em pixels. O valor LOWORD é a largura e o valor HIWORD é a altura. Se esses valores forem zero, as métricas do sistema SM_CXICON e SM_CYICON serão usadas. Para obter mais informações, consulte GetSystemMetrics.

Valor retornado (CPSFUNC_GET_PFNPROPSHEETUI_ICON)

Se a operação for bem-sucedida, a função ComPropSheet retornará um identificador de ícone; caso contrário, retornará NULL.

CPSFUNC_IGNORE_CPSUI_PSN_APPLY

O código de função CPSFUNC_IGNORE_CPSUI_PSN_APPLY faz com que a função ComPropSheet desabilite ou reabilite a manipulação do CPSUI da mensagem de notificação PSN_APPLY .

O sistema envia a mensagem de notificação PSN_APPLY para o CPSUI quando um usuário seleciona o botão OK ou Cancelar de uma folha de propriedades. O CPSUI responde a essa mensagem entregando o motivo CPSUICB_REASON_APPLYNOW para a função de retorno de chamada do tipo _CPSUICALLBACK de um aplicativo.

Se você desabilitar a manipulação do CPSUI da mensagem de notificação PSN_APPLY, deverá usar o código de função CPSFUNC_DO_APPLY_CPSUI para simular a entrega da mensagem de PSN_APPLY. Caso contrário, as alterações do usuário em uma página de folha de propriedades não poderão ser obtidas.

Se o código de função CPSFUNC_IGNORE_CPSUI_PSN_APPLY não for usado, o tratamento do CPSUI da mensagem de notificação PSN_APPLY será habilitado por padrão.

Parâmetros (CPSFUNC_IGNORE_CPSUI_PSN_APPLY)

  • hComPropSheet: identificador pai do grupo

  • Função: o chamador define esse parâmetro de código de função como CPSFUNC_IGNORE_CPSUI_PSN_APPLY quando chama o ComPropSheet para desabilitar ou reabilitar o tratamento do CPSUI da mensagem de notificação PSN_APPLY

  • lParam1: identificador CPSUI que se refere a um conjunto de uma ou mais páginas de folha de propriedades. Esse identificador deve ter sido obtido anteriormente por uma chamada para ComPropSheet com um código de função de CPSFUNC_ADD_PCOMPROPSHEETUI ou com um código de função de CPSFUNC_INSERT_PSUIPAGE e um tipo de inserção de PSUIPAGEINSERT_PROPSHEETPAGE.

  • lParam2: qualquer valor diferente de zero desabilita a entrega do CPSUI do motivo CPSUICB_REASON_APPLYNOW . Um valor zero reabilita a entrega do motivo CPSUICB_REASON_APPLYNOW .

Valor retornado (CPSFUNC_IGNORE_CPSUI_PSN_APPLY)

Se a operação for bem-sucedida, a função ComPropSheet retornará um valor diferente de zero; caso contrário, retornará zero.

CPSFUNC_INSERT_PSUIPAGE

O código da função CPSFUNC_INSERT_PSUIPAGE faz com que a função ComPropSheet insira um conjunto de páginas de folha de propriedades em uma posição específica.

Parâmetros (CPSFUNC_INSERT_PSUIPAGE)

  • hComPropSheet: identificador pai do grupo

  • Função: o chamador define esse parâmetro de código de função como CPSFUNC_INSERT_PSUIPAGE quando chama o ComPropSheet para inserir um conjunto de páginas de folha de propriedades em uma posição específica

  • lParam1: especifica um identificador para um conjunto de uma ou mais páginas de folha de propriedades. As novas páginas serão inseridas antes ou depois dessas páginas, dependendo do membro Mode da estrutura INSERTPSUIPAGE_INFO apontada por lParam2. Esse identificador deve ter sido obtido anteriormente por uma chamada ao ComPropSheet com um dos seguintes códigos de função:

    • CPSFUNC_ADD_HPROPSHEETPAGE

    • CPSFUNC_ADD_PCOMPROPSHEETUI

    • CPSFUNC_ADD_PFNPROPSHEETUI

    • CPSFUNC_ADD_PROPSHEETPAGE

    • CPSFUNC_INSERT_PSUIPAGE

  • lParam2: ponteiro para uma estrutura INSERTPSUIPAGE_INFO , descrevendo onde e como as novas páginas devem ser inseridas

Valor retornado (CPSFUNC_INSERT_PSUIPAGE)

Se a operação for bem-sucedida, a função ComPropSheet retornará um identificador para o conjunto de páginas que foram inseridas; caso contrário, a função retornará NULL.

CPSFUNC_LOAD_CPSUI_ICON

O código de função CPSFUNC_LOAD_CPSUI_ICON faz com que a função ComPropSheet carregue um recurso de ícone fornecido pelo CPSUI.

CPSUI chama LoadImage para carregar o recurso de ícone especificado.

Parâmetros (CPSFUNC_LOAD_CPSUI_ICON)

  • hComPropSheet: identificador pai do grupo

  • Função: o chamador define esse parâmetro de código de função como CPSFUNC_LOAD_CPSUI_ICON quando chama o ComPropSheet para carregar um recurso de ícone fornecido pelo CPSUI

  • lParam1: identificador de recurso do ícone fornecido pelo CPSUI a ser carregado. Esse deve ser um identificador prefixado por IDI_CPSUI, conforme definido em Compstui.h.

  • lParam2: especifica dois valores do tamanho do WORD que representam o tamanho do ícone, em pixels. O valor LOWORD é a largura e o valor HIWORD é a altura. Se esses valores forem zero, as métricas do sistema SM_CXICON e SM_CYICON serão usadas. Para obter mais informações, consulte GetSystemMetrics

Valor retornado (CPSFUNC_LOAD_CPSUI_ICON)

Se a operação for bem-sucedida, a função ComPropSheet retornará um identificador de ícone; caso contrário, retornará NULL.

CPSFUNC_LOAD_CPSUI_STRING

O código de função CPSFUNC_LOAD_CPSUI_STRING faz com que a função ComPropSheet carregue um recurso de cadeia de caracteres fornecido pelo CPSUI.

A função ComPropSheet chama a função LoadString](/windows/win32/api/winuser/nf-winuser-loadstringw) para carregar a cadeia de caracteres especificada.

Parâmetros (CPSFUNC_LOAD_CPSUI_STRING)

  • hComPropSheet: identificador pai do grupo

  • Função: o chamador define esse parâmetro de código de função como CPSFUNC_LOAD_CPSUI_STRING quando chama o ComPropSheet para carregar um recurso de cadeia de caracteres fornecido pelo CPSUI

  • lParam1: um ponteiro do tipo LPSTR para um buffer alocado pelo chamador, no qual a cadeia de caracteres fornecida pelo CPSUI especificada por HIWORD(lParam2) será colocada

  • lParam2: contém os dois valores fornecidos pelo chamador a seguir:

    • LOWORD(lParam2). Tamanho, em bytes, do buffer apontado por lParam1.

    • HIWORD(lParam2). Identificador de recurso da cadeia de caracteres fornecida pelo CPSUI a ser carregada. Esse deve ser um identificador prefixado por IDS_CPSUI, conforme definido em Compstui.h.

Valor retornado (CPSFUNC_LOAD_CPSUI_STRING)

Se a operação for bem-sucedida, a função ComPropSheet retornará o comprimento da cadeia de caracteres. Se um identificador de recurso inválido for especificado, a função retornará zero. Se lParam1 for NULL ou LOWORD(lParam2) for zero, a função retornará -1.

CPSFUNC_QUERY_DATABLOCK

O código da função CPSFUNC_QUERY_DATABLOCK faz com que a função ComPropSheet recupere um bloco de dados fornecido pelo chamador que foi armazenado anteriormente usando o código da função CPSFUNC_SET_DATABLOCK .

Normalmente, esse código de função é usado por uma função de retorno de chamada do tipo _CPSUICALLBACK (quando a estrutura CPSUICBPARAM da função contém um valor Reason de CPSUICB_REASON_SETACTIVE) para recuperar valores associados a outra página antes que a página atual fique inativa.

Parâmetros (CPSFUNC_QUERY_DATABLOCK)

  • hComPropSheet: identificador pai do grupo

  • Função: o chamador define esse parâmetro de código de função como CPSFUNC_QUERY_DATABLOCK quando chama o ComPropSheet para recuperar um bloco de dados fornecido pelo chamador

  • lParam1: ponteiro para uma estrutura CPSUIDATABLOCK que identifica o tamanho e o local de um buffer para receber o bloco de dados solicitado

  • lParam2: valor do identificador do tamanho DWORD, usado para identificar a estrutura CPSUIDATABLOCK solicitada. Esse valor deve ter sido especificado em uma chamada anterior para ComPropSheet usando o código da função CPSFUNC_SET_DATABLOCK .

Valor retornado (CPSFUNC_QUERY_DATABLOCK)

Se a operação for bem-sucedida, a função ComPropSheet retornará um valor que representa o tamanho do bloco de dados recuperado. Se lParam1 for NULL ou se o valor de qualquer membro da estrutura CPSUIDATABLOCK fornecida for zero, ComPropSheet retornará o tamanho necessário para armazenar o bloco de dados. Se ocorrer um erro, a função retornará um valor menor ou igual a zero.

CPSFUNC_SET_DATABLOCK

O código da função CPSFUNC_SET_DATABLOCK faz com que a função ComPropSheet armazene um bloco de dados fornecido pelo chamador. Você pode usar esse código de função para disponibilizar as informações sobre uma página de folha de propriedades para outras páginas.

Normalmente, esse código de função é usado por uma função de retorno de chamada do tipo _CPSUICALLBACK (quando a estrutura CPSUICBPARAM da função contém um valor Reason de CPSUICB_REASON_KILLACTIVE) para salvar valores associados a uma página antes de ficar inativa.

Parâmetros (CPSFUNC_SET_DATABLOCK)

  • hComPropSheet: identificador pai do grupo

  • Função: o chamador define esse parâmetro de código de função como CPSFUNC_SET_DATABLOCK quando chama o ComPropSheet para armazenar um bloco de dados fornecido pelo chamador

  • lParam1: ponteiro para uma estrutura CPSUIDATABLOCK que descreve o bloco de dados a ser armazenado

  • lParam2: valor do identificador do tamanho DWORD definido pelo chamador. Ele é usado para identificar a estrutura CPSUIDATABLOCK fornecida em chamadas subsequentes ao ComPropSheet usando o código de função CPSFUNC_QUERY_DATABLOCK .

Valor retornado (CPSFUNC_SET_DATABLOCK)

Se a operação for bem-sucedida, a função ComPropSheet retornará um valor que representa o número de bytes armazenados; caso contrário, retornará um valor menor ou igual a zero.

CPSFUNC_SET_DMPUB_HIDEBITS

O código da função CPSFUNC_SET_DMPUB_HIDEBITS faz com que a função ComPropSheet "oculte" um conjunto especificado de opções de propriedade do documento, para que elas não sejam exibidas.

Você pode usar o código da função CPSFUNC_SET_DMPUB_HIDEBITS se quiser definir estruturas OPTITEM para uma ou mais opções de folha de propriedades do documento, mas não quiser que as opções sejam modificáveis pelo usuário. A página da folha de propriedades deve ser definida usando a estrutura COMPROPSHEETUI e o membro pDlgPage da estrutura deve ser CPSUI_PDLGPAGE_DOCPROP ou CPSUI_PDLGPAGE_ADVDOCPROP.

Se você usar o código da função CPSFUNC_SET_DMPUB_HIDEBITS , ele deverá ser especificado para ComPropSheet antes que o código da função CPSFUNC_ADD_PCOMPROPSHEETUI ou CPSFUNC_INSERT_PSUIPAGE seja usado para criar a página.

Parâmetros (CPSFUNC_SET_DMPUB_HIDEBITS)

  • hComPropSheet: identificador pai do grupo

  • Função: o chamador define esse parâmetro de código de função como CPSFUNC_SET_DMPUB_HIDEBITS quando chama ComPropSheet para "ocultar" um conjunto especificado de opções de propriedade do documento

  • lParam1: ponteiro para uma matriz de bits que indica as opções a serem ocultadas. Essa matriz deve ser criada usando a macro MAKE_DMPUB_HIDEBIT (DMPub), em que DMPub é a combinação OR de uma ou mais constantes prefixadas por DMPUB_. As constantes prefixadas por DMPUB_ são listadas na descrição da estrutura OPTITEM . A macro e as constantes são definidas em Compstui.h.

  • lParam2: não usado, deve ser zero

Valor retornado (CPSFUNC_SET_DMPUB_HIDEBITS)

Se a operação for bem-sucedida, a função ComPropSheet retornará o valor especificado para lParam1; caso contrário, retornará zero.

CPSFUNC_SET_FUSION_CONTEXT

O CPSFUNC_SET_FUSION_CONTEXT define um contexto de ativação do Fusion para a página especificada.

Quando uma página está prestes a ser criada ou inserida e não especifica um contexto de ativação em sua estrutura PROPSHEETPAGE , ela será criada no contexto de ativação da página pai.

Se o contexto de ativação do pai não estiver definido, Compstui.dll procurará o pai do pai, continuando até que o pai de nível superior seja atingido ou até encontrar um pai com um contexto de ativação definido corretamente.

Se nenhum dos pais tiver um conjunto de contexto de ativação, Compstui.dll não especificará um contexto de ativação na estrutura PROPSHEETPAGE . Isso significa que a página será criada no contexto de ativação do chamador da função PropertySheet .

Parâmetros (CPSFUNC_SET_FUSION_CONTEXT)

  • hComPropSheet: identificador pai do grupo

  • Função: o chamador define esse parâmetro de código de função como CPSFUNC_SET_FUSION_CONTEXT quando chama ComPropSheet para definir um contexto de ativação fusion para a página especificada

  • lParam1: especifica o identificador para o contexto fusion. Compstui.dll duplica o identificador, anexando-o às suas estruturas internas, para que o chamador não seja obrigado a manter o identificador. Compstui.dll libera o identificador de contexto passado quando o identificador de Compstui.dll é excluído.

  • lParam2: não usado, deve ser zero

Valor retornado (CPSFUNC_SET_FUSION_CONTEXT)

Se a operação for bem-sucedida, a função ComPropSheet retornará um valor maior que zero. Caso contrário, ComPropSheet retornará um valor menor ou igual a zero. Para obter informações sobre o erro, use a função GetLastError .

CPSFUNC_SET_HSTARTPAGE

O código da função CPSFUNC_SET_HSTARTPAGE faz com que a função ComPropSheet marque uma página de folha de propriedades especificada como a página superior da folha de propriedades associada. Se a folha de propriedades estiver sendo exibida no momento, a página especificada se tornará a página ativa.

Parâmetros (CPSFUNC_SET_HSTARTPAGE)

  • hComPropSheet: identificador pai do grupo

  • Função: o chamador define esse parâmetro de código de função como CPSFUNC_SET_HSTARTPAGE quando chama ComPropSheet para marcar uma página de folha de propriedades especificada como a página superior da folha de propriedades associada

  • lParam1: identificador de página CPSUI fornecido pelo chamador, obtido anteriormente por uma chamada para ComPropSheet com um dos seguintes códigos de função:

    • CPSFUNC_ADD_HPROPSHEETPAGE

    • CPSFUNC_ADD_PCOMPROPSHEETUI

    • CPSFUNC_ADD_PFNPROPSHEETUI

    • CPSFUNC_ADD_PROPSHEETPAGE

    • CPSFUNC_INSERT_PSUIPAGE

    Se o identificador representar uma única página pertencente ao grupo especificado por hComPropSheet, CPSUI tornará esta página a página superior.

    Se o identificador representar um identificador pai de grupo (consulte CPSFUNC_INSERT_PSUIPAGE), lParam2 representará um índice baseado em zero nas páginas do grupo e a página representada pelo índice se tornará a página superior.

  • lParam2: se lParam1 representar um identificador pai de grupo, esse valor fornecido pelo chamador será um índice baseado em zero nas páginas do grupo. Se lParam1 representar uma única página pertencente ao grupo especificado por hComPropSheet, esse parâmetro não será usado. Se o identificador especificado por lParam1 tiver sido obtido usando o código de função CPSFUNC_ADD_PCOMPROPSHEETUI e se o membro pDlgPage da estrutura COMPROPSHEETUI associada tiver sido definido como CPSUI_PDLGPAGE_DOCPROP, um dos seguintes valores poderá ser especificado para lParam2:

    • SSP_STDPAGE1 - Torne a página Layout a página superior.

    • SSP_STDPAGE2 - Torne a página Papel/Qualidade na página superior.

    • SSP_TVPAGE - Torne a página Avançado a página superior.

Valor retornado (CPSFUNC_SET_HSTARTPAGE)

Se a operação for bem-sucedida, a função ComPropSheet retornará o valor especificado para lParam1; caso contrário, retornará zero.

CPSFUNC_SET_PSUIPAGE_ICON

O código da função CPSFUNC_SET_PSUIPAGE_ICON faz com que a função ComPropSheet adicione, substitua ou remova o ícone atribuído à guia de uma página de folha de propriedades.

Se lParam2 contiver um identificador de ícone e se a página especificada por lParam1 estiver sendo exibida no momento, CPSUI adicionará o ícone à guia da página especificada. Se um ícone já estiver atribuído à página, o ícone antigo será substituído pelo novo. Se lParam2 for zero, o ícone atual (se houver) será removido.

Para todos os ícones especificados com o código da função CPSFUNC_SET_PSUIPAGE_ICON , CPSUI define o tamanho da imagem como 16 por 16 pixels.

Identificadores de ícone devem ser obtidos chamando LoadImage.

Parâmetros (CPSFUNC_SET_PSUIPAGE_ICON)

  • hComPropSheet: identificador pai do grupo

  • Função: o chamador define esse parâmetro de código de função como CPSFUNC_SET_PSUIPAGE_ICON quando chama ComPropSheet para adicionar, substituir ou remover o ícone atribuído à guia de uma página de folha de propriedades

  • lParam1: identificador de página CPSUI fornecido pelo chamador, obtido anteriormente por uma chamada para ComPropSheet com um dos seguintes códigos de função:

    • CPSFUNC_ADD_HPROPSHEETPAGE

    • CPSFUNC_ADD_PROPSHEETPAGE

    • CPSFUNC_INSERT_PSUIPAGE (com o membro Type da estrutura INSERTPSUIPAGE_INFO definido como PSUIPAGEINSERT_HPROPSHEETPAGE ou PSUIPAGEINSERT_PROPSHEETPAGE)

  • lParam2: identificador de ícone fornecido pelo chamador. Você pode definir esse parâmetro como zero para remover o ícone atual

Valor retornado (CPSFUNC_SET_PSUIPAGE_ICON)

Se a operação for bem-sucedida, a função ComPropSheet retornará 1. Se um erro for encontrado ou se a página especificada não estiver sendo exibida no momento, a função retornará zero.

CPSFUNC_SET_PSUIPAGE_TITLE

O código da função CPSFUNC_SET_PSUIPAGE_TITLE faz com que a função ComPropSheet defina o título da guia para uma página de folha de propriedades.

Parâmetros (CPSFUNC_SET_PSUIPAGE_TITLE)

  • hComPropSheet: identificador pai do grupo

  • Função: o chamador define esse parâmetro de código de função como CPSFUNC_SET_PSUIPAGE_TITLE quando chama ComPropSheet para definir o título da guia para uma página de folha de propriedades

  • lParam1: identificador de página CPSUI fornecido pelo chamador, obtido anteriormente por uma chamada para ComPropSheet com um dos seguintes códigos de função:

    • CPSFUNC_ADD_HPROPSHEETPAGE

    • CPSFUNC_ADD_PROPSHEETPAGE

    • CPSFUNC_INSERT_PSUIPAGE (com o membro Type da estrutura INSERTPSUIPAGE_INFO definido como PSUIPAGEINSERT_HPROPSHEETPAGE ou PSUIPAGEINSERT_PROPSHEETPAGE).

  • lParam2: ponteiro fornecido pelo chamador para uma cadeia de caracteres terminada em NULL que especifica o novo título

Valor retornado (CPSFUNC_SET_PSUIPAGE_TITLE)

Se a operação for bem-sucedida, a função ComPropSheet retornará 1. Se um erro for encontrado ou se a página especificada não estiver sendo exibida no momento, a função retornará zero.

CPSFUNC_SET_RESULT

O código de função CPSFUNC_SET_RESULT faz com que a função ComPropSheet passe um valor de resultado especificado para todas as funções do tipo PFNPROPSHEETUI associadas a uma página especificada e seus pais.

Para obter mais informações sobre como definir valores de resultado, consulte a descrição da estrutura SETRESULT_INFO .

A advertência a seguir se aplica ao plug-in da interface do usuário IHV baseada em Unidrv ou Pscript5 com folhas de propriedades de interface do usuário personalizadas e para as quais as configurações de usuário feitas nas folhas de propriedades devem ser persistentes. Quando o plug-in chama a função ComPropSheet com o parâmetro Function definido como CPSFUNC_SET_RESULT, o plug-in deve definir o parâmetro lParam2 como CPSUI_OK.

Parâmetros (CPSFUNC_SET_RESULT)

  • hComPropSheet: identificador pai do grupo

  • Função: o chamador define esse parâmetro de código de função como CPSFUNC_SET_RESULT quando chama o ComPropSheet para passar um valor de resultado especificado para todas as funções do tipo PFNPROPSHEETUI associadas a uma página especificada e seus pais.

  • lParam1: identificador CPSUI fornecido pelo chamador para a página para a qual um valor de resultado está sendo passado. Se lParam1 for NULL, o CPSUI usará o valor especificado por hComPropSheet.

  • lParam2: valor de resultado DWORD de 32 bits fornecido pelo chamador.

Valor retornado (CPSFUNC_SET_RESULT)

Se a operação for bem-sucedida, a função ComPropSheet retornará o número de funções do tipo PFNPROPSHEETUI que foram chamadas. Se o identificador especificado para lParam1 for inválido, a função retornará -1.

Requisitos

Requisito Valor
Plataforma de Destino Área de Trabalho
Cabeçalho compstui.h (inclua Compstui.h)