IMsgServiceAdmin::ConfigureMsgService
Aplica-se a: Outlook 2013 | Outlook 2016
Reconfigura um serviço de mensagem.
HRESULT ConfigureMsgService(
LPMAPIUID lpUID,
ULONG_PTR ulUIParam,
ULONG ulFlags,
ULONG cValues,
LPSPropValue lpProps
);
Parâmetros
lpUID
[in] Um ponteiro para a estrutura MAPIUID que contém o identificador exclusivo para o serviço de mensagem configurar.
ulUIParam
[in] Um identificador para a janela pai da folha de propriedades de configuração.
ulFlags
[in] Um bitmask de sinalizadores que controla a exibição da folha de propriedades. Os seguintes sinalizadores podem ser definidos:
MAPI_UNICODE
As cadeias de caracteres passadas estão no formato Unicode. Se o sinalizador MAPI_UNICODE não estiver definido, as cadeias de caracteres estarão no formato ANSI.
MSG_SERVICE_UI_READ_ONLY
O serviço de mensagem deve exibir sua folha de propriedades de configuração, mas não permitir que o usuário a altere. A maioria dos serviços de mensagem ignora esse sinalizador.
SERVICE_UI_ALLOWED
O serviço de mensagem deve exibir sua folha de propriedades de configuração somente se o serviço não estiver completamente configurado.
SERVICE_UI_ALWAYS
O serviço de mensagem deve sempre exibir sua folha de propriedades de configuração. Se SERVICE_UI_ALWAYS não estiver definido, uma folha de propriedades de configuração ainda poderá ser exibida se SERVICE_UI_ALLOWED estiver definida e as informações de configuração válidas não estiverem disponíveis na matriz de valor da propriedade no parâmetro lpProps . SERVICE_UI_ALLOWED ou SERVICE_UI_ALWAYS devem ser definidos para que uma folha de propriedades seja exibida.
cValues
[in] A contagem de valores de propriedade na estrutura SPropValue apontada por lpProps.
lpProps
[in] Um ponteiro para uma matriz de valores de propriedade que descrevem as propriedades a serem exibidas na folha de propriedades. O parâmetro lpProps não deve ser NULL se o serviço de mensagem deve ser configurado sem uma interface do usuário.
Valor de retorno
S_OK
O serviço de mensagem foi configurado com êxito.
MAPI_E_EXTENDED_ERROR
Um erro específico para um serviço de mensagem. Para obter a estrutura MAPIERROR que descreve o erro, o aplicativo cliente deve chamar o método IMsgServiceAdmin::GetLastError .
MAPI_E_NOT_FOUND
O MAPIUID apontado por lpUID não corresponde ao de um serviço de mensagem existente.
MAPI_E_NOT_INITIALIZED
O serviço de mensagem não tem uma função de ponto de entrada.
MAPI_E_USER_CANCEL
O usuário cancelou a operação, normalmente clicando no botão Cancelar na folha de propriedades.
Comentários
O método IMsgServiceAdmin::ConfigureMsgService permite que um serviço de mensagem seja configurado com ou sem uma folha de propriedades de configuração.
Para permitir a configuração sem uma exibição de folha de propriedades, os serviços de mensagem normalmente preparam um arquivo de cabeçalho que inclui constantes para todas as propriedades necessárias e opcionais e seus valores.
Notas para chamadores
Para recuperar a estrutura MAPIUID para o serviço de mensagem configurar, recupere a coluna PR_SERVICE_UID (PidTagServiceUid) da linha do serviço de mensagem na tabela de serviço de mensagem. Para obter mais informações, consulte o procedimento descrito no método IMsgServiceAdmin::CreateMsgService .
Você pode configurar um serviço de mensagem sem exibir uma folha de propriedades para um usuário somente se tiver informações antecipadas sobre os valores da propriedade a serem definidos. Se você estiver configurando um serviço de mensagem sem exibir uma folha de propriedades, passe valores de propriedade válidos no parâmetro lpProps e não defina os sinalizadores MSG_SERVICE_UI_READ_ONLY, SERVICE_UI_ALLOWED ou SERVICE_UI_ALWAYS.
Se você receber todas ou algumas das informações de configuração do usuário por meio de uma folha de propriedades, defina SERVICE_UI_ALLOWED em ulFlags. Se você usar informações de propriedade existentes apenas para estabelecer configurações padrão e o usuário puder alterar as configurações, defina SERVICE_UI_ALWAYS em ulFlags.
Referência do MFCMAPI
Para ver códigos de exemplo do MFCMAPI, confira a tabela a seguir.
| Arquivo | Função | Comentário |
|---|---|---|
| MAPIProfileFunctions.cpp |
HrAddServiceToProfile |
O MFCMAPI usa o método IMsgServiceAdmin::ConfigureMsgService para configurar um serviço que foi adicionado a um perfil. |