Función RasGetEntryPropertiesA (ras.h)
La función RasGetEntryProperties recupera las propiedades de una entrada de libreta de teléfonos.
Sintaxis
DWORD RasGetEntryPropertiesA(
[in] LPCSTR unnamedParam1,
[in] LPCSTR unnamedParam2,
[in, out] LPRASENTRYA unnamedParam3,
[in, out] LPDWORD unnamedParam4,
[out] LPBYTE unnamedParam5,
[in, out] LPDWORD unnamedParam6
);
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 de teléfonos (PBK). Si este parámetro es NULL, la función usa el archivo de libreta de teléfonos 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 un nombre de entrada existente. Si se especifica una cadena vacía, la función devuelve valores predeterminados en los búferes a los que apuntan los parámetros lpRasEntry y lpbDeviceInfo .
[in, out] unnamedParam3
Puntero a una estructura RASENTRY seguida de bytes adicionales para la lista de números de teléfono alternativos, si hay una.
En la salida, la estructura recibe los datos de conexión asociados a la entrada de la libreta de teléfonos especificada por el parámetro lpszEntry .
En la entrada, establezca el miembro dwSize de la estructura en sizeof(RASENTRY) para identificar la versión de la estructura.
Este parámetro puede ser NULL.
Windows Me/98 y Windows 95 OSR2: La capa de Microsoft para Unicode no admite dwAlternateOffset en RASENTRY.
[in, out] unnamedParam4
Puntero a una variable que, en la entrada, especifica el tamaño, en bytes, del búfer lpRasEntry .
En la salida, esta variable recibe el número de bytes necesarios.
Este parámetro puede ser NULL si el parámetro lpRasEntry es NULL.
Para determinar el tamaño de búfer necesario, llame a RasGetEntryProperties con lpRasEntry establecido en NULL y *lpdwEntryInfoSize establecido en cero. La función devuelve el tamaño de búfer necesario en *lpdwEntryInfoSize.
[out] unnamedParam5
Este parámetro ya no se usa. La función de llamada debe establecer este parámetro en NULL.
Windows Me/98/95: Puntero a un búfer que recibe información de configuración específica del dispositivo. No manipule directamente esta información opaca del dispositivo TAPI. Para obtener más información sobre la configuración del dispositivo TAPI, consulte la función lineGetDevConfig en la referencia del programador de TAPI en el SDK de plataforma.
Este parámetro puede ser NULL.
[in, out] unnamedParam6
Este parámetro no se utiliza. La función de llamada debe establecer este parámetro en NULL.
Windows Me/98/95: Puntero a una variable que, en la entrada, especifica el tamaño, en bytes, del búfer especificado por el parámetro lpbDeviceInfo .
En la salida, esta variable recibe el número de bytes necesarios.
Este parámetro puede ser NULL si el parámetro lpbDeviceInfo s NULL.
Para determinar el tamaño de búfer necesario, llame a RasGetEntryProperties con lpbDeviceInfo establecido en NULL y *lpdwDeviceInfoSize establecido en cero. La función devuelve el tamaño de búfer necesario en *lpdwDeviceInfoSize.
Valor devuelto
Si la función se ejecuta correctamente, el valor devuelto es 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 Enrutamiento y códigos de error de acceso remoto o Winerror.h.
| Valor | Significado |
|---|---|
|
Se llamó a la función con un parámetro no válido. |
|
El valor del miembro dwSize de lpRasEntry es demasiado pequeño. |
|
La dirección o el búfer especificados por lpRasEntry no son válidos. |
|
El tamaño del búfer indicado en lpdwEntryInfoSize es demasiado pequeño. |
|
La entrada de la libreta de teléfonos no existe o el archivo de libreta de teléfonos está dañado o tiene componentes que faltan. |
Comentarios
Nota
El encabezado ras.h define RasGetEntryProperties 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 neutro de codificación con código que no es neutral de codificación puede provocar discrepancias que dan lugar a errores de compilación o en 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 |
Consulte también
Información general sobre el servicio de acceso remoto (RAS)