Sobre cierto resultado de la función SHGetSpecialFolderPath

[dec]

Hola,

A raíz de este hilo me he propuesto realizar una sencilla clase que cuenta solo con un método cuyo cometido es devolver la ruta de un directorio "especial" de Windows determinado, como puedan ser los directorios "Mis documentos", "Mi música", etcétera.

Para ello, principalmente, hago uso de la función del API de Windows "SHGetSpecialFolderPath" (más información sobre ella en el hilo citado arriba).

Es el caso que prácticamente he concluído dicha sencilla clase (o al menos me lo creo) pero encuentro un problema con el resultado de la referida función: este es... cómo lo diría... incorrecto, en cierto modo. No el esperado en cualquier caso.

Por ejemplo, si primero trato de hallar la ruta de un directorio y acto seguido compruebo la existencia del mismo el resultado es correcto, puesto que, efectivamante, el directorio cuya existencia se comprueba existe: así me lo indica la función "DirectoryExists" que utilizo para tal fin.

Sin embargo, si lo que pretendo es añadir a la ruta del directorio obtenido alguna cadena,... aun cuando realizo la concatenación de la ruta y la cadena y el compilador no se queja de nada lo que obtengo al cabo es la ruta del directorio, pero sin la cadena unida a la misma.

Supóngase que quiere crearse un directorio en donde está instalado Windows. Entonces pretendo hacer algo así:

Código Delphi [-]
 // Implementación de la función que uso para ello
 class function TDirectoriosWindows.RutaDirectorio(const
   directorio: TDirWin; crear: boolean) : string;
 begin
   SetLength(Result, MAX_PATH);
   SHGetSpecialFolderPath(GetCurrentProcess, PChar(Result),
     NumeroDirectorio(directorio), crear);
 end;
 
 // La cual puedo llamar de esta manera:
 (...)
 var
   s: string;
 begin
   s := TDirectoriosWindows.RutaDirectorio(dew_DirectorioWindows, false);
   // ... para a continuación...
   s := s +'\'+ otroDirectorio;
   ShowMessage(s);
 end;

He omitido algunas cuestiones, pero, creo que puede entenderse si digo que el "ShowMessage" me devuelve "C:\Windows",... y ni rastro de "\otroDirectorio".

Llama la atención el "ShowMessage", puesto que muestre la ruta "C:\Windows", tal como se espera, pero, con lo que parece un buen número de espacios en blanco a la derecha de dicha ruta... de tal manera que el "ShowMessage" se sale de la pantalla, ni más ni menos.

Traté de pasar el resultado/la ruta por "TrimRight", pero, esto no funciona. Y, si en lugar de mostrar la ruta en un "ShowMessage" la añado a una línea de un "TMemo" en esta no sobran caracteres, no hay caracteres en blanco, puede verse, en este caso "C:\Windows", sin más...

¿Cómo es posible esto? Creo que tendrá que ver con cómo trabajo con la función "SHGetSpecialFolderPath", concretamente con la instrucción "SetLength(Result, MAX_PATH);" que puede verse más arriba.

Sin embargo, recurro a vuestra ayuda, a ver si podéis orientarme, como estoy seguro de que así será. Adjunto la unidad en la que implemento la sencilla clase "TDirectoriosWindows".

Si en algo no me he explicado, pues me lo hacéis saber y trato de hacerlo de buena gana. Muchas gracias de antemano por vuestra ayuda.

[roman]

Empezado por dec

Creo que tendrá que ver con cómo trabajo con la función "SHGetSpecialFolderPath", concretamente con la instrucción "SetLength(Result, MAX_PATH);"

Pues a ojo de buen cubero supongo que, en efecto, aquí está el problema. Creo que hay que entender dos cosas:

1. El porqué de SetLength
2. Qué es un string

1. Normalmente Delphi manejará de forma automática la asignación, reasignación y destrucción de la memoria asociada a un string. Dado que tú estás usando una función de la API de Windows para vaciar datos en el string, Delphi pierde la oportunidad de poder manejar automáticamente la asignación y por ello hay que ayudarle indicándole la cantidad de memoria que debe asignar.

Esto creo que ya lo sabes pero hay que observar que le estás diciendo que la cadena va a ser siempre de tamaño MAX_PATH aun cuando ShGetSpecialFolderPath devuelva una cadena mucho menor (como en 'C:\Windows')

2. Bueno, parece obvio pero el caso es que un string en Delphi ha llegado a ser mucho más que el original tipo de datos planeado por Wirth. Aunque el término 'string' conlleva el significado histórico de una "cadena de caracteres", en realidad un string puede almacenar cualquier secuencia de bytes y no sólo los correspondientes a caracteres. Y esto incluye el byte 0, que es justamente el byte que la API de Windows usa para indicar el final de una cadena.

Entonces, en tu uso de ShGetSpecialFolderPath, lo que obtienes es un string de longitud MAX_PATH con los siguientes datos (binarios):

'C:\Windows0.................................................'

donde los puntos significan "basura", cualquier cosa que hubiera en esa localidad de memoria (posiblemente ceros, no estoy seguro de si SetLength inicializa a ceros la memoria asignada).

La causa exacta de los errores que obtienes no la sé pero muy posiblemente tenga relación con esto que te explico: obtienes una cadena "demasiado" larga.

Creo que una forma de solucionarlo sería usando un arreglo de caracteres para recibir el resultado de ShGetSpecialFolderPath:

Código Delphi [-]
var
  Buffer: array[0..MAX_PATH] of Char;

begin
  SHGetSpecialFolderPath(
    GetCurrentProcess,
    Buffer,
    NumeroDirectorio(directorio),
    crear
  );

  Result := Buffer;
end;

Un arreglos de caracteres (basado en cero) es compatible tanto con un PChar como con un String. Windows no tiene problemas para uar el buffer declarado y la asignación Result := Buffer se encargará de la conversión apropiada a string.

Al margen de esto, me parece que no es correcto usar GetCurrentProcess como primer parámetro de ShGetSpecialFolderPath. El parámetro, según el SDK de Windows debe ser un identificador de ventana, no de un proceso.

// Saludos

[dec]

Hola roman,

Muchas gracias por tu interés y tu ayuda: todo salió a pedir de boca, como no podía ser de otro modo. Muy interesantes además los comentarios que realizas al hilo del problema que planteaba.

1. El porqué de SetLength

Efectivamente, el "SetLengh" parece ser que sobraba en este caso. Luego añadiré más sobre esto.

Esto creo que ya lo sabes pero hay que observar que le estás diciendo que la cadena va a ser siempre de tamaño MAX_PATH aun cuando ShGetSpecialFolderPath devuelva una cadena mucho menor (como en 'C:\Windows')

Bueno... no, en realidad no puedo decir que lo supiera: fue un copia y pega, poco más o menos, lo que me llevó al problema. En realidad he realizado algún "plugin" (librería, dll) para determinado programa que, efectivamente, trabaja con "PChar's" y estos tiene que ser liberados luego de usarse, pero, en todo caso, no puedo decir que entendiera el quid del asunto.

Más claro me queda (ahora que tú lo pones así) el que estaba utilizando el tamaño de "MAX_PATH", aun cuando esto, como se puede comprobar, no es necesario: de hecho no es necesario el "SetLengh".

La causa exacta de los errores que obtienes no la sé pero muy posiblemente tenga relación con esto que te explico: obtienes una cadena "demasiado" larga.

Desde luego yo tampoco conozco la causa exacta, pero, puesto que en realidad no se trataba de un error (o sí, pero, no), sino de cierto resultado no esperado en todos los casos (recuerdo que si trataba de comprobar la existencia de un directorio, aun con la "basura" de datos, todo parecía ir bien), efectivamente, todo indica que el problema residía en obtener una cadena demasiado larga, como dices.

Creo que una forma de solucionarlo sería usando un arreglo de caracteres para recibir el resultado de ShGetSpecialFolderPath:

Así es roman. Y el caso es que lo tuve "a punto": repasé un poco el Foro (no hace mucho se trató el tema de cómo averiguar el nombre de la computadora, por ejemplo, y no iba del todo mal desencaminado, creo) y encontré e intenté hacer algo así:

Código Delphi [-]
 (...)
 var
   buffer: array[0..MAX_PATH] of Char;
 begin
   SetLength(buffer, MAX_PATH);
   SHGetSpecialFolderPath(GetCurrentProcess, buffer,
     NumeroDirectorio(directorio), crear);
   Result := buffer;
 end;

Pero ese código "no compila". Provoca el error: "Constant object cannot be passed as var parameter"... todavía no tengo muy claro de qué se trata, pero, el error estaba en la instrucción mal usada: "SetLength". Esto, sin duda, pasa por copiar y pegar más de la cuenta y no saber lo que uno se trae entre manos.

Un arreglos de caracteres (basado en cero) es compatible tanto con un PChar como con un String. Windows no tiene problemas para uar el buffer declarado y la asignación Result := Buffer se encargará de la conversión apropiada a string.

Interesante roman. Personalmente, porque acaso no halla terminado con los "plugins" que antes mencioné que he hecho y aún haré, y tal vez lo que dices pueda servirme de algo y aun de algos: es cuestión de que me entre en esta cabecita, así de chiquitita.

Al margen de esto, me parece que no es correcto usar GetCurrentProcess como primer parámetro de ShGetSpecialFolderPath. El parámetro, según el SDK de Windows debe ser un identificador de ventana, no de un proceso.

Efectivamente. En realidad he usado lo tal porque en parte he basado "la clase" en cierta función incluída en la librería DelphiWorks en que se hace uso de "GetCurrentProcess" para algo, que, sin lugar a dudas, sería parecido... pero no me fijé lo suficiente como para ver que no era del todo válido para lo que pretendía hacer.

He pensado en cambiarlo por "GetActiveWindow", pero, puesto que no estoy muy seguro de obtener el resultado esperado, y además esta función, en caso de fallo devuelve "null" y acaso esto pueda causar problemas, he decidido, al menos por el momento, incluir un nuevo parámetro al único método de "TDirectoriosWindows", el cual solicita precisamente el "OwnerHandle" que precisa la función "SHGetSpecialFolderPath".

He visto en la "idea" publicada en el Grupo Albor por Francisco Charte referida en el hilo a que antes hacía mención que dicho autor hace uso del "Handle" del formulario en que utiliza la función "SHGetSpecialFolderPath" y, por el momento, en lugar de "GetActiveWindows", como digo, he preferido solicitar un parámetro similar, aunque tal vez esto sea cargar el mochuelo al potencial usuario de "TDirectoriosWindows"...

Bueno roman. Gracias de nuevo por todo. No podía esperar menos de ti ni de este lugar. Adjunto la unidad donde se implementa "TDirectoriosWindows" con las modificaciones comentadas y ya funcionando, al menos, sin el problema que ha originado este hilo.

[roman]

Empezado por dec

repasé un poco el Foro (no hace mucho se trató el tema de cómo averiguar el nombre de la computadora, por ejemplo, y no iba del todo mal desencaminado, creo) y encontré e intenté hacer algo así:

Código Delphi [-]
 (...)
 var
   buffer: array[0..MAX_PATH] of Char;
 begin
   SetLength(buffer, MAX_PATH);
   SHGetSpecialFolderPath(GetCurrentProcess, buffer,
     NumeroDirectorio(directorio), crear);
   Result := buffer;
 end;

Eso pasa por no buscar en el lugar "correcto"

// Saludos