Win32 API
Utilizando la documentación de MSDN

Introducción

Observaciones

Tipos de documentación disponibles

La biblioteca de MSDN contiene varios tipos diferentes de documentación que se pueden usar para implementar características.

• Visión general de temas Estos son descripciones generales de temas destinados a proporcionar una comprensión general de una API. Estas descripciones generales a menudo también describen las mejores prácticas y las estrategias de implementación.
• Las muestras demuestran el uso de API particulares. Estos son generalmente muy simplificados, no necesariamente hacen la comprobación de errores y, por lo general, no usan marcos como MFC o ATL. Proporcionan un punto de partida para el uso de características.
• Detalles de referencia todos los elementos de cada API. Esto incluye constantes / enumeraciones, interfaces, funciones y clases.

Nota: muchos empleados de Microsoft también mantienen blogs, como The Old New Thing de Raymond Chen, que puede complementar la documentación, pero estos blogs no son un sustituto de la documentación.

Encontrar documentación para una característica

Encontrar documentación para una característica a menudo es tan simple como buscar con un buen motor de búsqueda. Si eso falla, o si no está seguro acerca de los términos específicos, el índice API de Windows puede ayudar a localizar características específicas. La documentación para métodos, interfaces, enumeraciones y constantes generalmente se puede encontrar buscando el nombre usando un motor de búsqueda. Además, el Centro de desarrollo de Windows puede proporcionar un valioso punto de partida.

Uso de la documentación de la función

La documentación para una función se divide en varias secciones:

Visión general

Describe para qué se utiliza la función. Esta sección también mostrará información sobre si la función está depreciada o puede que no esté disponible en versiones futuras.

Sintaxis

Muestra la declaración de la función desde el encabezado de origen apropiado. Es una referencia rápida a la firma de la función.

Parámetros

Explica cada uno de los parámetros, si el parámetro es entrada o salida, y otras consideraciones importantes.

Valor de retorno

Esta sección explica el resultado de la llamada a la función, incluido cómo detectar errores y qué información adicional está disponible. (Por ejemplo, esta sección indicará explícitamente si GetLastError proporcionará información adicional sobre el manejo de errores).

Observaciones

Cubre toda la información adicional requerida para usar la función, como, por ejemplo, información sobre funciones de soporte, obtención de identificadores adecuados y eliminación de recursos.

Ejemplos

Si esta sección está disponible, tiene un ejemplo del uso apropiado de la función para usar como punto de partida para la implementación.

Requerimientos

Proporciona información importante sobre los requisitos previos para llamar a la función. Esta información incluye:

• Cliente / servidor mínimo admitido Primera versión del sistema operativo (compatible con Microsoft) para proporcionar la función.
  _{(Tenga en cuenta que este campo es notoriamente engañoso. A menudo, las funciones son compatibles con una versión anterior del sistema operativo, pero este campo solo muestra la versión más antigua que actualmente es compatible con Microsoft . Por ejemplo, la función CreateWindow ha sido compatible desde Windows 1.0 , pero la documentación solo muestra que ha sido admitida desde Windows 2000. La versión en línea de la documentación de MSDN no indica que ninguna función fuera compatible con una versión de Windows anterior a 2000, aunque muchas sí lo eran. Para el desarrollo heredado, debe consultar una versión anterior de la documentación del SDK, como podría haber sido enviada en un CD-ROM de MSDN. O bien, consulte los archivos de encabezado.)}
• Encabezado El encabezado del SDK para #include que contiene la declaración de función. Si la función no está disponible en un encabezado, esto mostrará información sobre el procedimiento para llamar a la función (generalmente se llama a GetProcAddress para realizar el enlace dinámico en tiempo de ejecución).
• Biblioteca El archivo de biblioteca que se pasa al vinculador para resolver las funciones exportadas.
• DLL El archivo (tal como se incluye con el sistema operativo) que contiene la función exportada.
• Fin del soporte de cliente / servidor La última versión de Windows para admitir oficialmente la API.
• Nombres Unicode y ANSI Para las funciones de cadena que tienen variantes Unicode y ANSI, esto enumera los nombres reales exportados para las dos funciones. Este suele ser solo el nombre de la función con un sufijo W o A (respectivamente).