Función ORGetValue
Recupera el tipo y los datos del valor del Registro especificado en un subárbol del registro sin conexión.
Sintaxis
DWORD ORGetValue(
_In_ ORHKEY Handle,
_In_opt_ PCWSTR lpSubKey,
_In_opt_ PCWSTR lpValue,
_Out_opt_ PDWORD pdwType,
_Out_opt_ PVOID pvData,
_Inout_opt_ PDWORD pcbData
);
Parámetros
-
Identificador [in]
-
Identificador de una clave del Registro abierta en un subárbol del registro sin conexión.
-
lpSubKey [in, opcional]
-
Nombre de la clave del Registro. Esta clave debe ser una subclave de la clave especificada por el parámetro Handle . Este parámetro puede ser NULL.
Los nombres de clave no distinguen mayúsculas de minúsculas.
-
lpValue [in, opcional]
-
Nombre del valor del Registro. Si este parámetro es NULL o una cadena vacía, "", la función recupera el tipo y los datos del valor predeterminado o sin nombre de la clave, si existe. Para obtener más información, vea Límites de tamaño de elemento del Registro.
Las claves no tienen automáticamente un valor predeterminado o sin nombre. Los valores sin nombre pueden ser de cualquier tipo.
Los nombres de valor no distinguen mayúsculas de minúsculas.
-
pdwType [out, opcional]
-
Puntero a una variable que recibe un código que indica el tipo de datos almacenados en el valor especificado. Para obtener una lista de los posibles códigos de tipo, vea Tipos de valor del Registro. Este parámetro puede ser NULL si el tipo no es necesario.
-
pvData [out, optional]
-
Puntero a un búfer que recibe los datos del valor. Este parámetro puede ser NULL si los datos no son necesarios.
Si los datos son una cadena, la función comprueba si hay un carácter nulo de terminación. Si no se encuentra uno, la cadena se almacena con un terminador NULO si el búfer es lo suficientemente grande como para dar cabida al carácter adicional. De lo contrario, se produce un error en la función y se devuelve ERROR_MORE_DATA.
-
pcbData [in, out, optional]
-
Puntero a una variable que especifica el tamaño del búfer al que apunta el parámetro pvData , en bytes. Cuando se devuelve la función, esta variable contiene el tamaño de los datos copiados en pvData.
El parámetro pcbData solo puede ser NULL si pvData es NULL.
Si los datos tienen el REG_SZ, REG_MULTI_SZ o REG_EXPAND_SZ tipo, este tamaño incluye cualquier carácter o caracteres nulos de terminación. Para obtener más información, vea la sección Comentarios.
Si el búfer especificado por el parámetro pvData no es lo suficientemente grande como para contener los datos, la función devuelve ERROR_MORE_DATA y almacena el tamaño de búfer necesario en la variable a la que apunta pcbData. En este caso, el contenido del búfer pvData no está definido.
Si pvData es NULL y pcbData no es NULL, la función devuelve ERROR_SUCCESS y almacena el tamaño de los datos, en bytes, en la variable a la que apunta pcbData. Esto permite a una aplicación determinar la mejor manera de asignar un búfer para los datos del valor.
Valor devuelto
Si la función se ejecuta correctamente, el valor devuelto es ERROR_SUCCESS.
Si la función no se ejecuta correctamente, el valor devuelto es un código de error distinto de cero definido en Winerror.h. Puede usar la función FormatMessage con la marca FORMAT_MESSAGE_FROM_SYSTEM para obtener una descripción genérica del error.
Observaciones
Normalmente, una aplicación llama a la función OREnumValue para determinar los nombres de valor y, a continuación, llama a la función ORGetValue para recuperar los datos de los nombres.
Requisitos
| Requisito | Value |
|---|---|
| Redistribuible |
Biblioteca del Registro sin conexión de Windows versión 1.0 o posterior |
| Encabezado |
|
| Archivo DLL |
|
Consulte también