Cuándo es necesario/apropiado usar InAttribute y OutAttribute para COM Interop

Question

Estoy tratando de atravesar el desorden de las definiciones de interoperabilidad COM que hemos esparcido a través de varios proyectos y recopilarlos en una sola ubicación conocida, buena de la cual el conjunto el equipo de desarrollo puede beneficiarse. Parte de este esfuerzo implica limpiar las definiciones que se han acumulado a lo largo de los años.

Algunos de estos son prestados de otro código fuente, algunos se copiaron textualmente de pinvoke.net, y algunos parecen traducirse directamente de los encabezados del SDK. Una cosa que noto es que no hay consistencia sobre cuándo usar los diversos atributos de clasificación, (incluso entre los ejemplos de pinvoke.net, esto es acertado o extraño). Parte del problema es que no creo que nadie aquí (incluido yo) entienda completamente cuándo se necesitan o no los diversos atributos, o qué es lo que realmente hacen. Hasta este punto, hacerlo bien parece ser una combinación de conjeturas y cambios aleatorios hasta que las COMExcepciones dejen de suceder, pero prefiero que las traducciones sean correctas porque alguien las miró y las declaró.

Por lo tanto, estoy comenzando con [In] y [Out]. Sé lo que hacen esos dos atributos conceptualmente: informan al marshaller en qué dirección deben ir los datos. I asume el Marshaller, por ejemplo, no se molestará en copiar datos de [In] a la persona que llama, o sabe que los datos de [Out] podrían necesitar ser liberados en el lado del destinatario, etc. Las cosas que no sé son:

1. ¿Cuándo es necesario para utilizar estos atributos? Es decir, ¿cuándo se equivocó el comportamiento de clasificación predeterminado de modo que los atributos lo hagan correcto?
2. ¿Cuándo es seguro para utilizar estos atributos? Es decir, ¿va a especificar qué debe ser el comportamiento predeterminado para cambiar la forma en que funciona el marcador?
3. ¿Cuándo es peligroso para utilizar estos atributos? Supongo que marcar explícitamente un parámetro de salida [In] es malo, pero está marcando un parámetro de entrada [In, Out] que realmente va a romper algo?

Así, dado un método de interfaz COM hipotética cuya IDL se ve así:

HRESULT Foo(
    [in] ULONG a, 
    [out] ULONG * b 
    [in, out] ULONG * c); 

que podrían ver esto traduce como cualquiera de los siguientes:

void Foo(
    uint cb, 
    out uint b, 
    ref uint c); 

void Foo(
    uint cb, 
    [Out] out uint b, 
    [In, Out] ref uint c); 

void Foo(
    [In] uint cb, 
    [Out] out uint b, 
    [In, Out] ref uint c); 

¿Hay alguna diferencia funcional entre esos tres? ¿Alguno de ellos se considera "mejor" que los otros por razones además de la corrección técnica?

Answer 1

No, no es estrictamente necesario aplicar ninguno de estos atributos en su propio código. Todos son opcionales y se aplican automáticamente a tu código según el tipo de parámetro.

En esencia, tienen las siguientes palabras clave equivalentes de C#:

• Usted recibe [In] por defecto.
• La palabra clave ref le consigue [In, Out].
• La palabra clave out te consigue [Out].

Todo documentado en una bonita tabla here.

Solo necesita usarlos cuando desee alterar esa semántica implícita o cambiar el comportamiento predeterminado del contador de referencias. Por ejemplo, puede marcar un parámetro declarado ref con el atributo [In] solo para suprimir la parte "salir" de la clasificación.

Dicho esto, me encuentro utilizándolos porque son una forma muy fácil de hacer que el código se auto-documente.