Função NdisCoGetTapiCallId (ndis.h)

NdisCoGetTapiCallId recupera uma cadeia de caracteres que os aplicativos TAPI podem usar para identificar uma VC (conexão virtual) NDIS específica.

Sintaxe

NDIS_STATUS NdisCoGetTapiCallId(
  [in]      NDIS_HANDLE NdisVcHandle,
  [in, out] PVAR_STRING TapiCallId
);

Parâmetros

[in] NdisVcHandle

Especifica o identificador NDIS para a VC. Esse identificador foi fornecido pelo NDIS quando a VC foi criada originalmente com a função NdisCoCreateVc .

[in, out] TapiCallId

Ponteiro para um buffer alocado pelo chamador que recebe uma estrutura de dados do tipo VAR_STRING. Após o retorno bem-sucedido, essa estrutura descreve uma cadeia de caracteres que os aplicativos TAPI podem usar para identificar a VC.

Retornar valor

Retorna um dos seguintes valores de status:

Código de retorno Descrição
NDIS_STATUS_SUCCESS
O NDIS retornou com êxito um identificador de cadeia de caracteres para a VC.
NDIS_STATUS_BUFFER_TOO_SHORT
O membro ulTotalSize da estrutura VAR_STRING especifica que o tamanho do buffer não é grande o suficiente para manter a cadeia de caracteres que identifica a VC. NdisCoGetTapiCallId define o membro ulNeededSize da estrutura VAR_STRING para o tamanho necessário em bytes.
NDIS_STATUS_INVALID_DATA
O identificador para a VC especificada por NdisVcHandle não é válido.

Comentários

Suponha que um gerenciador de chamadas chame NdisCoCreateVc para criar uma VC para uma chamada TAPI. O NDIS, por sua vez, fornece o identificador para a VC para um cliente. O cliente passa esse identificador de VC em uma chamada para a função NdisCoGetTapiCallId para recuperar uma cadeia de caracteres que identifica a VC. O cliente pode passar esse identificador de cadeia de caracteres para um aplicativo TAPI para identificar a VC.

O cliente cria um contexto para cada VC que gerencia. O cliente usa NdisCoGetTapiCallId para recuperar um identificador de cadeia de caracteres para cada VC. O cliente passa cada identificador de cadeia de caracteres para um aplicativo TAPI para identificar cada VC. Posteriormente, se um aplicativo TAPI passar um desses identificadores de cadeia de caracteres para o cliente em uma operação relacionada à VC, o cliente deverá passar esse identificador de cadeia de caracteres como uma cadeia de caracteres Unicode em uma chamada para NdisClGetProtocolVcContextFromTapiCallId para recuperar o contexto correto para a VC.

Para obter mais informações sobre a estrutura VAR_STRING, consulte Objetos TAPI.

Requisitos

Requisito Valor
Cliente mínimo com suporte Com suporte para drivers NDIS 6.0 e NDIS 5.1 (consulte NdisCoGetTapiCallId (NDIS 5.1)) no Windows Vista. Com suporte para drivers NDIS 5.1 (consulte NdisCoGetTapiCallId (NDIS 5.1)) no Windows XP.
Plataforma de Destino Área de Trabalho
Cabeçalho ndis.h (inclua Ndis.h)
Biblioteca Ndis.lib
IRQL DISPATCH_LEVEL
Regras de conformidade da DDI Irql_Connection_Function(ndis)

Confira também

NdisClGetProtocolVcContextFromTapiCallId

NdisCoCreateVc