Método TCallbackMessage

Last modified: May 02, 2020

TCallbackMessage é usado para receber mensagens de status e outras respostas de texto do Alteryx Engine.

Retorna 1 para cancelar a execução do fluxo de trabalho ou aplicativo ou 0 para continuar.

Declaração do método

long AlteryxApi.CallbackMessage( 
	__int64 userData,
	int nToolId,
	int nStatus,
	const wchar_t* pMessage
)

userData: O valor do parâmetro userData passou para a chamada para um dos seguintes métodos: AlteryxRunModule, AlteryxRunModule2, AlteryxRunModule_Pipe, AlteryxRunModule_Pipe2, AlteryxRunWizardou AlteryxRunWizard_Pipe.

nToolId: O ID numérico para a ferramenta da a que o progresso está sendo relatado. -1 indica o progresso que vem diretamente do motor de Alteryx.

pMessage: A mensagem de texto.

nStatus: Um valor que especifica que tipo de mensagem está sendo entregue.
Os valores válidos são:

 

1 Informações estão sendo passadas para o aplicativo de chamada.
2 Foi relatado um aviso. A mensagem será a mensagem de aviso.
3 Indica que ocorreu um erro. A mensagem será a mensagem de erro.
4 A ferramenta concluiu seu processamento.
5 Indica que ocorreu um erro de conversão de campo. A mensagem será a mensagem de erro.
6 Indica que o limite de erro de conversão de campo foi atingido.
7 Uma mensagem transitória está sendo enviada de uma ferramenta. Isso é semelhante a nStatus = 1, com as seguintes diferenças:

Uma mensagem nova substituirá/supercede todas as mensagens velhas da mesma ferramenta (isto é, pode somente sempre ser uma mensagem transiente de uma ferramenta dada).

A mensagem sempre será originadas de uma macro.
10 10 a mensagem será o XML que é a meta informações atualizadas para esta ferramenta.
11 A mensagem será o XML que é a configuração para esta ferramenta.
12 Isto fará com que o config refresque no GUI sem a interação do usuário. Typicaly isso é feito quando a ferramenta já está em um estado de erro, mas talvez a GUI pode corrigi-lo sem interação do usuário.
13 Normalmente, uma ferramenta de navegação. A mensagem será o caminho do arquivo temporário.
20 Isso dirá ao aplicativo de chamada que o espaço livre em disco está em execução baixa e pausar o fluxo de trabalho até que a ação seja executada.
30 Indica que a mensagem será uma lista delimitada ' \n ' de opções que o aplicativo de chamada deve fazer uma seleção de. O manipulador de retorno de chamada deve retornar um dos seguintes valores para indicar a escolha que é feita. Os valores válidos são:-1 para cancelar-2 para 1 para todos-3 para nenhum a todos os 0 para nenhum 1... N para um valor específico da lista de opções
40 Os nomes de campo para esta ferramenta de saída SRCT em uma seqüência delimitada por aspas vírgulas.
41 O registro de dados para essa ferramenta de saída SRCT em uma cadeia de caracteres delimitada por aspas.
50 Indica o número e o tamanho dos registros de saída pela ferramenta até o momento. A cadeia de caracteres será no formato: "OutputName | RecordCount\nTotalSize "

O parâmetro nStatus indica que tipo de mensagem está sendo entregue a partir do fluxo de trabalho ou aplicativo em execução.

Se o aplicativo de chamada determina o fluxo de trabalho ou aplicativo deve interromper o processamento com base no conteúdo do retorno de chamada, o nStatus parâmetro deve retornar 1. Para permitir que o processamento continue, o parâmetro nStatus deve retornar 0. A única exceção é quando nStatus é 30, o manipulador de retorno de chamada deve retornar um dos seguintes valores para indicar a escolha que é feita:-1 para cancelar,-2 para 1 a todos,-3 para nenhum a todos, 0 para None, 1.... N para um valor específico da lista de opções.

Exemplo

long CallbackMessage (__int64 userData,
	int nToolId,
	int nStatus,
	const wchar_t* pMessage)
{
	switch (nStatus)
{
	caso 3:
		há um erro para retornar 1 para cancelar o processamento
		retornar 1;
}
	retorno 0;
}
Esta página foi útil?

Problemas com seu produto Alteryx? Visite a Comunidade Alteryx ou entre em contato com nossa Equipe de Suporte. Não é possível enviar este formulário? Envie-nos um e-mail.