Função de retorno de chamada RasCustomScriptExecuteFn (ras.h)

Artigo
08/25/2023

RAS chama a função RasCustomScriptExecute ao estabelecer uma conexão para uma entrada de catálogo telefônico que tenha a opção RASEO_CustomScript definida.

Sintaxe

RasCustomScriptExecuteFn Rascustomscriptexecutefn;

DWORD Rascustomscriptexecutefn(
  [in] HANDLE hPort,
  [in] LPCWSTR lpszPhonebook,
  [in] LPCWSTR lpszEntryName,
  [in] PFNRASGETBUFFER pfnRasGetBuffer,
  [in] PFNRASFREEBUFFER pfnRasFreeBuffer,
  [in] PFNRASSENDBUFFER pfnRasSendBuffer,
  [in] PFNRASRECEIVEBUFFER pfnRasReceiveBuffer,
  [in] PFNRASRETRIEVEBUFFER pfnRasRetrieveBuffer,
  [in] HWND hWnd,
  [in] RASDIALPARAMS *pRasDialParams,
       PVOID pvReserved
)
{...}

Parâmetros

[in] hPort

Manipule para a porta na qual a conexão é estabelecida. Use esse identificador ao enviar ou receber dados na porta.

[in] lpszPhonebook

Ponteiro para uma cadeia de caracteres Unicode que contém o caminho para a lista telefônica na qual reside a entrada da conexão.

[in] lpszEntryName

Ponteiro para uma cadeia de caracteres Unicode que contém o nome da entrada que foi discada para estabelecer a conexão.

[in] pfnRasGetBuffer

Ponteiro para uma função do tipo PFNRASGETBUFFER. A DLL de script personalizado deve usar essa função para alocar memória para enviar dados ao servidor.

[in] pfnRasFreeBuffer

Ponteiro para uma função do tipo PFNRASFREEBUFFER. A DLL de script personalizado deve usar essa função para liberar a memória alocada pela função pfnRasGetBuffer .

[in] pfnRasSendBuffer

Ponteiro para uma função do tipo PFNRASSENDBUFFER. A DLL de script personalizado usa essa função para se comunicar com o servidor pela porta especificada.

[in] pfnRasReceiveBuffer

Ponteiro para uma função do tipo PFNRASRECEIVEBUFFER. A DLL de script personalizado usa essa função para se comunicar com o servidor pela porta especificada.

[in] pfnRasRetrieveBuffer

Ponteiro para uma função do tipo PFNRASRETRIEVEBUFFER. A DLL de script personalizado usa essa função para se comunicar com o servidor pela porta especificada.

[in] hWnd

Manipule para uma janela que a DLL de script personalizado pode usar para apresentar uma interface do usuário ao usuário.

[in] pRasDialParams

Ponteiro para uma estrutura RASDIALPARAMS unicode. Essa estrutura contém as credenciais de autenticação do usuário. A DLL de script personalizado pode modificar os membros szUserName, szPassword e szDomain dessa estrutura. O Protocolo Ponto a Ponto (PPP) usará o que estiver armazenado nesses membros quando RasCustomScriptExecute retornar.

pvReserved

Retornar valor

Se a função for bem-sucedida, o valor retornado deverá ser ERROR_SUCCESS.

Se a função falhar, o valor retornado deverá ser um código de erro apropriado de Winerror.h ou Raserror.h.

Comentários

Quando RAS chama RasCustomScriptExecute, o parâmetro pRasDialParams apontará para a estrutura RASDIALPARAMS unicode. Ou seja, a estrutura contém apenas cadeias de caracteres Unicode.

Em alguns casos, o szUserName da estrutura RASDIALPARAMS será uma cadeia de caracteres vazia. Nesses casos, a DLL de script personalizado deve usar a versão Unicode da função GetUserName para obter o nome do usuário atual.

Requisitos

Requisito	Valor
Cliente mínimo com suporte	Windows 2000 Professional [somente aplicativos da área de trabalho]
Servidor mínimo com suporte	Windows 2000 Server [somente aplicativos da área de trabalho]
Plataforma de Destino	Windows
Cabeçalho	ras.h