Função RasSetSubEntryPropertiesA (ras.h)

  • Artigo

A função RasSetSubEntryProperties cria uma nova subentrada ou modifica uma subentidade existente de uma entrada de catálogo telefônico especificada.

Sintaxe

DWORD RasSetSubEntryPropertiesA(
  [in] LPCSTR         unnamedParam1,
  [in] LPCSTR         unnamedParam2,
  [in] DWORD          unnamedParam3,
  [in] LPRASSUBENTRYA unnamedParam4,
  [in] DWORD          unnamedParam5,
  [in] LPBYTE         unnamedParam6,
  [in] DWORD          unnamedParam7
);

Parâmetros

[in] unnamedParam1

Ponteiro para uma cadeia de caracteres terminada em nulo que especifica o caminho completo e o nome de arquivo de um arquivo de catálogo telefônico (PBK). Se esse parâmetro for NULL, a função usará o arquivo de catálogo telefônico padrão atual. O arquivo de catálogo telefônico padrão é aquele selecionado pelo usuário na folha de propriedades Preferências do Usuário da caixa de diálogo Rede Discada .

Windows Me/98/95: Esse parâmetro sempre deve ser NULL. A rede discada armazena entradas de catálogo telefônico no registro em vez de em um arquivo de catálogo telefônico.

[in] unnamedParam2

Ponteiro para uma cadeia de caracteres terminada em nulo que especifica o nome de uma entrada existente na lista telefônica.

[in] unnamedParam3

Especifica o índice baseado em um da subentrada. Se o índice corresponder a um índice de subentrada existente, a função alterará as propriedades dessa subentrada. Se o índice não corresponder a um índice existente, a função criará uma nova subentidade.

[in] unnamedParam4

Ponteiro para a estrutura RASSUBENTRY que especifica os dados da subentidade.

A estrutura pode ser seguida por uma matriz de cadeias de caracteres de número de telefone alternativo terminadas em nulo. A última cadeia de caracteres é encerrada por dois caracteres nulos consecutivos. O membro dwAlternateOffset da estrutura RASSUBENTRY contém o deslocamento para a primeira cadeia de caracteres.

[in] unnamedParam5

Especifica o tamanho, em bytes, do buffer lpRasSubEntry .

[in] unnamedParam6

Ponteiro para um bloco de configuração de dispositivo TAPI. No momento, esse parâmetro não é usado. O chamador deve passar NULL para esse parâmetro. Para obter mais informações sobre blocos de configuração de dispositivo TAPI, consulte a função lineGetDevConfig.

[in] unnamedParam7

Especifica o tamanho do bloco de configuração do dispositivo TAPI. No momento, esse parâmetro não é usado. O chamador deve passar zero para esse parâmetro.

Retornar valor

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

Se a função falhar, o valor retornado será um dos seguintes códigos de erro ou um valor de Códigos de Erro de Roteamento e Acesso Remoto ou Winerror.h.

Valor Significado
ERROR_BUFFER_INVALID
 O endereço ou buffer especificado por lpRasEntry é inválido.
ERROR_CANNOT_FIND_PHONEBOOK_ENTRY
 A entrada da lista telefônica não existe.
ERROR_CANNOT_OPEN_PHONEBOOK
 A lista telefônica está corrompida ou está faltando componentes.
ERROR_INVALID_PARAMETER
 A função foi chamada com um parâmetro inválido.

Comentários

Uma entrada de catálogo telefônico RAS pode ter zero ou mais subentidades, cada uma minimamente composta por um dispositivo e um número de telefone. Uma entrada de catálogo telefônico com várias subentidades pode ser configurada para discar a primeira subentrada disponível ou todas as subentidades quando a entrada é discada.

Use a função RasGetEntryProperties para recuperar a estrutura RASENTRY que contém informações sobre as subentidades de uma entrada de catálogo telefônico. O membro dwSubEntries indica o número de subentries e o membro dwDialMode indica a configuração de discagem.

Observação

O cabeçalho ras.h define RasSetSubEntryProperties como um alias que seleciona automaticamente a versão ANSI ou Unicode dessa função com base na definição da constante de pré-processador UNICODE. Misturar o uso do alias neutro de codificação com código que não seja neutro em codificação pode levar a incompatibilidades que resultam em erros de compilação ou de runtime. Para obter mais informações, consulte Convenções para protótipos de função.

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
Biblioteca Rasapi32.lib
DLL Rasapi32.dll

Confira também

RASENTRY

RASSUBENTRY

Rasgetentryproperties

Visão geral do RAS (Serviço de Acesso Remoto)

Funções do serviço de acesso remoto