optional (atributo)
El atributo [opcional] especifica un parámetro opcional para una función miembro.
return-type function-name([optional [, other-attributes]] parameter-type parameter-name)
Parámetros
-
return-type
-
Especifica el tipo de valor devuelto de la función.
-
function-name
-
Especifica el nombre de la función tal y como se define en el archivo IDL.
-
otros atributos
-
Cero o más atributos MIDL opcionales.
-
parameter-type
-
Tipo de datos del parámetro opcional.
-
parameter-name
-
Especifica el nombre del parámetro opcional.
Comentarios
El atributo [opcional] solo es válido si el parámetro es de tipo VARIANT o VARIANTÂ *.
El compilador MIDL acepta el siguiente orden de parámetros (de izquierda a derecha):
- Parámetros obligatorios (parámetros que no tienen los atributos [defaultvalue] o [opcional] ),
- Parámetros opcionales con o sin el atributo [defaultvalue],
- Parámetros con el atributo [opcional] y sin el atributo [defaultvalue],
- [lcid] parámetro, si existe,
- [retval] parámetro
No se puede aplicar el atributo [opcional] a un parámetro que también tenga los atributos [lcid] o [retval].
Ejemplos
HRESULT MyFunc([in, optional] VARIANT Param1,
[out, optional] VARIANT Param2)
Vea también