Función RasGetSubEntryPropertiesA (ras.h)

Artículo
03/05/2024

La función RasGetSubEntryProperties recupera información sobre un subentry para una entrada de libreta de teléfono especificada.

Sintaxis

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

Parámetros

[in] unnamedParam1

Puntero a una cadena terminada en null que especifica la ruta de acceso completa y el nombre de archivo de un archivo de libreta telefónica (PBK). Si este parámetro es NULL, la función usa el archivo de libreta telefónica predeterminado actual. El archivo de libreta telefónica predeterminado es el seleccionado por el usuario en la hoja de propiedades Preferencias de usuario del cuadro de diálogo Redes de acceso telefónico .

Windows Me/98/95: Este parámetro siempre debe ser NULL. Las redes de acceso telefónico almacenan entradas de libreta de teléfonos en el registro en lugar de en un archivo de libreta de teléfonos.

[in] unnamedParam2

Puntero a una cadena terminada en null que especifica el nombre de una entrada existente en la libreta de teléfonos.

[in] unnamedParam3

Especifica el índice basado en un solo elemento del subentry.

[in, out] unnamedParam4

Puntero a la estructura RASSUBENTRY seguida de bytes adicionales para la lista de números de teléfono alternativo, si hay una.

En la salida, la estructura recibe información sobre el subentry especificado.

En la entrada, el miembro dwSize especifica el tamaño de la estructura. El tamaño identifica la versión de la estructura. Obtenga este tamaño mediante sizeof(RASSUBENTRY).

Este parámetro puede ser NULL.

[in, out] unnamedParam5

Puntero a una variable que especifica, en la entrada, el tamaño, en bytes, del búfer lpRasSubEntry .

En la salida, la variable recibe el número de bytes devueltos o el número de bytes necesarios si el búfer es demasiado pequeño.

Este parámetro puede ser NULL si lpRasSubEntry es NULL.

[in] unnamedParam6

Puntero a un bloque de configuración de dispositivo TAPI. Este parámetro no se usa actualmente. El autor de la llamada debe pasar NULL para este parámetro. Para obtener más información sobre los bloques de configuración de dispositivos TAPI, consulte la línea de funciónGetDevConfig.

[in] unnamedParam7

Puntero a un DWORD que especifica el tamaño del bloque de configuración del dispositivo TAPI. Este parámetro no se usa actualmente. El autor de la llamada debe pasar NULL para este parámetro.

Valor devuelto

Si la función se ejecuta correctamente, el valor devuelto se ERROR_SUCCESS.

Si se produce un error en la función, el valor devuelto es uno de los siguientes códigos de error o un valor de Códigos de error de enrutamiento y acceso remoto o Winerror.h.

Valor	Significado
ERROR_INVALID_PARAMETER	Se llamó a la función con un parámetro no válido.
ERROR_BUFFER_INVALID	La dirección o el búfer especificados por lpRasSubEntry no son válidos.
ERROR_BUFFER_TOO_SMALL	El búfer lpRasSubEntry es demasiado pequeño. La variable lpdwcb recibe el tamaño de búfer necesario.
ERROR_CANNOT_OPEN_PHONEBOOK	La libreta de teléfonos está dañada o falta componentes.
ERROR_CANNOT_FIND_PHONEBOOK_ENTRY	La entrada de la libreta de teléfonos no existe.

Comentarios

Una entrada de libreta de teléfono RAS puede tener cero o más subentries, cada uno de los cuales consta mínimamente de un dispositivo y un número de teléfono. Se puede configurar una entrada de libreta de teléfonos con varias subentries para marcar las primeras entradas disponibles o todas las entradas cuando se marca la entrada.

Use la función RasGetEntryProperties para recuperar una estructura RASENTRY que contiene información sobre los subelementos de una entrada de libreta de teléfonos. El miembro dwSubEntries indica el número de subentries y el miembro dwDialMode indica la configuración de marcado.

Nota

El encabezado ras.h define RasGetSubEntryProperties como alias que selecciona automáticamente la versión ANSI o Unicode de esta función en función de la definición de la constante de preprocesador UNICODE. La combinación del uso del alias neutral de codificación con código que no es neutral de codificación puede dar lugar a errores de coincidencia que dan lugar a errores de compilación o tiempo de ejecución. Para obtener más información, vea Convenciones para prototipos de función.

Requisitos

Requisito	Value
Cliente mínimo compatible	Windows 2000 Professional [solo aplicaciones de escritorio]
Servidor mínimo compatible	Windows 2000 Server [solo aplicaciones de escritorio]
Plataforma de destino	Windows
Encabezado	ras.h
Library	Rasapi32.lib
Archivo DLL	Rasapi32.dll