Command line parameters and environment variables/es: what changed

Revision 2 to 3. Removed lines have a minus sign; added lines have a plus sign.

Old	New		Line
1	1		Parámetros de la línea de órdenes y variables de entorno
2	2
3	3		## Introducción
4	4
5	5		Al arrancar un programa el usuario puede poner en la línea de órdenes parámetros y variables de entorno de la configuración. Por ejemplo, el compilador de FreePascal obtiene la mayoría de sus parámetros por medio de las opciones de la línea de orden:
6	6
7		-	~~` fpc -Fudirectory -gh unidad1.pas`~~
	7	+	```text
	8	+	fpc -Fudirectory -gh unidad1.pas
	9	+	```
8	10
9	11		## Lo esencial de Parámetros de la línea de órdenes
10	12
11	13		Un programa Pascal accede a los parámetros por medio de ParamStr y ParamCount. ParamStr(0) contiene el nombre (y la ruta si el sistema lo permite) del programa mismo. ParamStr(1) es el primer parámetro. ParamCount es el número de parámetros.
12	14
13	15		``` pascal
14	16		program Project1;
15	17		{$mode objfpc}{$H+}
16	18		var
17	19		i: Integer;
18	20		begin
19	21		writeln('Programa: ',ParamStr(0));
20	22		for i:=1 to ParamCount do
21	23		writeln('Parámetro ',i,': ',ParamStr(i));
22	24		end.
23	25		```
24	26
25	27		Por ejemplo:
26	28
27	29		$ /tmp/proyecto1 -a
28	30		Programa: /tmp/proyecto1
29	31		Parámetro 1: -a
30	32
31	33		## Parámetros de línea de órdenes cómodos
32	34
33	35		Un buen programa debe dar un mensaje de ayuda cuando es invocado con los parámetros incorrectos y debe seguir una forma consistente de leer los parámetros. La unidad custapp que viene con FPC proporciona la clase TCustomApplication, que proporciona las funciones que fácilmente comprueba y lee parámetros. Por supuesto se puede tener acceso a los parámetros directamente vía ParamStr y ParamCount.
34	36
35	37		Todas las aplicaciones LCL utilizan esto de forma automática. El objeto Application es un TCustomApplication.
36	38
37	39		Si queremos escribir un programa no LCL, crearemos en Lazarus un proyecto del tipo Aplicación de consola. Con esto conseguiremos un proyecto con algunas utilidades que casi todos los programas necesitan. Utilizaremos el método DoRun
38	40
39	41		### Comprobando los parámetros
40	42
41	43		Con TCustomApplication podemos acceder a los parámetros por su nombre. Por ejemplo el programa puede mostrar un texto de ayuda cuándo el usuario solicita el parámetro de ayuda -?, o --ayuda en su forma larga. Para comprobar cuándo el usuario llama al programa con -? or --ayuda utilizaremos esto:
42	44
43	45		``` pascal
44	46		if HasOption('h?','ayuda') then begin
45	47		MuestraAyuda;
46	48		Halt;
47	49		end;
48	50		```
49	51
50	52		Nota: En un formulario de la LCL hay que preceder con Application. a HasOption. Por ejemplo:
51	53
52	54		``` pascal
53	55		if Application.HasOption('?','ayuda') then begin
54	56		MuestraAyuda;
55	57		Halt;
56	58		end;
57	59		```
58	60
59	61		``` pascal
60	62		// Sí únicamente queremos admitir la opción corta usaremos:
61	63		if HasOption('?','') then ...
62	64		// Sí únicamente queremos admitir la opción larga usaremos:
63	65		if HasOption('ayuda') then ...
64	66		```
65	67
66	68		### Leyendo el valor del parámetro
67	69
68	70		Cada parámetro puede tener un valor. Por ejemplo:
69	71
70		-	~~` proyecto1 -a nombrefichero`~~
	72	+	```text
	73	+	proyecto1 -a nombrefichero
	74	+	```
71	75
72	76		o en una forma larga:
73	77
74		-	~~` project1 --archivo=nombrefichero`~~
	78	+	```text
	79	+	project1 --archivo=nombrefichero
	80	+	```
75	81
76	82		``` pascal
77	83		writeln('archivo = ',GetOptionValue('a','archivo'));
78	84		```
79	85
80	86		Nota: Si se obtiene el mensaje de error Option at position 1 needs an argument : a. es que hemos olvidado añadir la opción en la llamada CheckOptions.
81	87
82	88		Nota: En un formulario de la LCL hay que preceder con Application. a GetOptionValue.
83	89
84	90		### Comprobando la validez de los parámetros
85	91
86	92		Los parámetros de la línea de órdenas son de texto libre, por lo que el usuario puede fácilmente cometer errores al escribirlos. Comprobar la sintaxis de los parámetros es obligatorio. Podemos utilizar el método [[doc:fcl/custapp/tcustomapplication.checkoptions.html\|CheckOptions]] para ello:
87	93
88	94		Debemos definir que parámetros hay disponibles, cuales necesitan dar un valor, y en caso de error de sintaxis podemos obtener un mensaje que informe de forma detallada y útil las opciones que son incorrectas.
89	95
90	96		Ejemplos:
91	97
92	98		``` pascal
93	99		ErrorMsg:=CheckOptions('?a:','ayuda archivo:');
94	100		```
95	101
96	102		Con esto permitimos las opciones cortas -? y -a valor. Así mismo permitimos las opciones largas '--ayuday--archivo=valor. No está permitido ni--ayudacon un valor, ni --archivo'' sin un valor.
97	103
98	104		---
99	105		From the Free Pascal wiki, page "Command line parameters and environment variables/es", as it stood on 2020-02-11 after a change by Trev, out of the wiki's dump of 2024-05-26. Copyright stays with the author who wrote it, according to the old wiki's [[Licensing]] page. If you have concerns about this material, [message the admin](/wiki-contact).
100	106		Category: Castellano
101	107		Category: Español

Back to history