Função LoadBitmapW (winuser.h)
[LoadBitmap está disponível para uso nos sistemas operacionais especificados na seção Requisitos. Ele poderá ser alterado ou ficar indisponível em versões subsequentes. Em vez disso, use LoadImage e DrawFrameControl.]
A função LoadBitmap carrega o recurso de bitmap especificado do arquivo executável de um módulo.
Sintaxe
HBITMAP LoadBitmapW(
[in] HINSTANCE hInstance,
[in] LPCWSTR lpBitmapName
);
Parâmetros
[in] hInstance
Um identificador para a instância do módulo cujo arquivo executável contém o bitmap a ser carregado.
[in] lpBitmapName
Um ponteiro para uma cadeia de caracteres terminada em nulo que contém o nome do recurso bitmap a ser carregado. Como alternativa, esse parâmetro pode consistir no identificador de recurso na palavra de baixa ordem e zero na palavra de alta ordem. A macro MAKEINTRESOURCE pode ser usada para criar esse valor.
Retornar valor
Se a função for bem-sucedida, o valor retornado será o identificador para o bitmap especificado.
Se a função falhar, o valor retornado será NULL.
Comentários
Se o bitmap apontado pelo parâmetro lpBitmapName não existir ou não houver memória suficiente para carregar o bitmap, a função falhará.
LoadBitmap cria um bitmap compatível da exibição, que não pode ser selecionado para uma impressora. Para carregar um bitmap que você pode selecionar para uma impressora, chame LoadImage e especifique LR_CREATEDIBSECTION para criar uma seção DIB. Uma seção DIB pode ser selecionada para qualquer dispositivo.
Um aplicativo pode usar a função LoadBitmap para acessar bitmaps predefinidos. Para fazer isso, o aplicativo deve definir o parâmetro hInstance como NULL e o parâmetro lpBitmapName como um dos valores a seguir.
| Nome do bitmap | Nome do bitmap |
|---|---|
| OBM_BTNCORNERS | OBM_OLD_RESTORE |
| OBM_BTSIZE | OBM_OLD_RGARROW |
| OBM_CHECK | OBM_OLD_UPARROW |
| OBM_CHECKBOXES | OBM_OLD_ZOOM |
| OBM_CLOSE | OBM_REDUCE |
| OBM_COMBO | OBM_REDUCED |
| OBM_DNARROW | OBM_RESTORE |
| OBM_DNARROWD | OBM_RESTORED |
| OBM_DNARROWI | OBM_RGARROW |
| OBM_LFARROW | OBM_RGARROWD |
| OBM_LFARROWD | OBM_RGARROWI |
| OBM_LFARROWI | OBM_SIZE |
| OBM_MNARROW | OBM_UPARROW |
| OBM_OLD_CLOSE | OBM_UPARROWD |
| OBM_OLD_DNARROW | OBM_UPARROWI |
| OBM_OLD_LFARROW | OBM_ZOOM |
| OBM_OLD_REDUCE | OBM_ZOOMD |
Os nomes de bitmap que começam com OBM_OLD representam bitmaps usados por versões de 16 bits do Windows anteriores à 3.0.
Para que um aplicativo use qualquer uma das constantes OBM_, a constante OEMRESOURCE deve ser definida antes que o arquivo de cabeçalho Windows.h seja incluído.
O aplicativo deve chamar a função DeleteObject para excluir cada identificador de bitmap retornado pela função LoadBitmap .
Exemplos
Para obter um exemplo, consulte Exemplo de Menu-Item Bitmaps em Usando Menus.
Observação
O cabeçalho winuser.h define LoadBitmap como um alias que seleciona automaticamente a versão ANSI ou Unicode dessa função com base na definição da constante de pré-processador UNICODE. Misturar o uso do alias neutro de codificação com código que não seja neutro em codificação pode levar a incompatibilidades que resultam em erros de compilação ou de runtime. Para obter mais informações, consulte Convenções para protótipos de função.
Requisitos
| Requisito | Valor |
|---|---|
| Cliente mínimo com suporte | Windows 2000 Professional [somente aplicativos da área de trabalho] |
| Servidor mínimo com suporte | Windows 2000 Server [somente aplicativos da área de trabalho] |
| Plataforma de Destino | Windows |
| Cabeçalho | winuser.h (inclua Windows.h) |
| Biblioteca | User32.lib |
| DLL | User32.dll |
| Conjunto de APIs | ext-ms-win-ntuser-draw-l1-1-1 (introduzido em Windows 8.1) |