Русский справочник по Win32 API

От изготовителя fb2.

Данная книга (кроме всего прочего) содержит таблицы, к сожалению не все читалки могут их воспроизводить.

Давайте, протестируем вашу читалку.

Если, вместо симпатичной таблицы вы увидели такое:

1 строка, 1 столбец

1 строка, 2 столбец

1 строка, 3 столбец

2 строка 1 столбец

2 строка 2 столбец

...

Значит ваша читалка таблиц не видит, что очень жаль, т.к. в книге их 49.

Что делать?... Ну, я поступаю так. В Mozilla Firefox поставил плагин для чтения fb2, и все проблемы решены, конечно, возможны и другие варианты...

Вот и все.

Успехов w_cat.

CreatePalette

Функция CreatePalette создает логическую цветовую палитру.

HPALETTE CreatePalette (

CONST LOGPALETTE * lplgpl // указатель на логическую цветовую палитру

);

Параметры

lplgpl - указывает на структуру типа LOGPALETTE , которая содержит информацию о цветах в логической палитре.

Возвращаемые значения

В случае успеха возвращается дескриптор, который идентифицирует логическую палитру.

В случае неудачи возвращается NULL . Для получения дополнительной информации об ошибке вызовите функцию GetLastError .

Комментарии

Приложение может определить, поддерживает ли устройство операции с палитрами, вызвав GetDeviceCaps и определив константу RASTERCAPS .

Создав логическую палитру, приложение может ее выбрать в контекст устройства, вызвав функцию SelectPalette . Палитра, выбранная в контекст устройства, может быть реализована функцией RealizePalette .

Когда вы более не нуждаетесь в палитре, вызовите функцию DeleteObject для ее удаления.

См. также

DeleteObject, GetDeviceCaps, LOGPALETTE, RealizePalette, SelectPalette .

GetNearestColor

Функция GetNearestColor возвращает цветовое значение, идентифицирующее цвет из системной палитры, который будет отображаться, когда используется указанное цветовое значение.

COLORREF GetNearestColor (

HDC hdc , // дескриптор контекста устройства

COLORREF crColor // подбираемый цвет

);

Параметры

hdc - идентифицирует контекст устройства.

crColor - определяет цветовое значение, идентифицирующее запрашиваемый цвет.

Возвращаемые значения

В случае успеха возвращается цвет из системной палитры, который соответствует данному цветовому значению.

В случае неудачи возвращается CLR _ INVALID . Для получения дополнительной информации об ошибке вызовите функцию GetLastError .

См. также

GetDeviceCaps, GetNearestPaletteIndex, COLORREF .

GetSystemPaletteEntries

Функция GetSystemPaletteEntries извлекает диапазон вхождений в палитру из системной палитры, которая связана с указанным контекстом устройства (device context).

UINT GetSystemPaletteEntries (

HDC hdc , // дескриптор контекста устройства

UINT iStartIndex , // первое извлекаемое вхождение в палитру

UINT nEntries , // количество извлекаемых вхождений в палитру

LPPALETTEENTRY lppe // массив, получающий вхождения в палитру

);

Параметры

hdc - дескриптор контекста устройства

iStartIndex - определяет первое извлекаемое вхождение в системную палитру.

nEntries - определяет количество извлекаемых из системной палитры вхождений.

lppe - указатель на массив структур типа PALETTEENTRY для получения вхождений в палитру. Число элементов в массиве должно быть не меньше значения, заданного параметром nEntries . Если значение параметра lppe равно NULL, функция возвращает общее количество вхождений в системную палитру.

Возвращаемые значения

В случае успеха возвращается количество вхождений, извлеченных из палитры.

В случае неудачи возвращается нуль.

Windows NT/2000/XP: Для получения дополнительной информации об ошибке вызовите функцию GetLastError.

Комментарии

Приложение может определить, поддерживает ли устройство операции с палитрой, вызвав функцию GetDeviceCaps с параметром RASTERCAPS.

Требования

Windows NT/2000/XP: Включена в Windows NT 3.1 и выше.

Windows 95/98/Me: Включена в Windows 95 и выше.

Заголовок: Объявлена в Wingdi.h; подключатьWindows.h.

Библиотека: Используйте Gdi32.lib.

См. также

GetDeviceCaps, GetPaletteEntries, PALETTEENTRY.

ResizePalette

Функция ResizePalette увеличивает или уменьшает размер логической палитры, основываясь на указанном значении.

BOOL ResizePalette (

HPALETTE hpal , // дескриптор логической палитры

UINT nEntries // число вхождений в логическую палитру

);

Параметры

hpal - идентифицирует изменяемую логическую палитру.

nEntries - определяет число вхождений в палитру после изменения ее размера.

Возвращаемые значения

В случае успеха возвращается ненулевое значение.

В случае неудачи возвращается нуль. Для получения дополнительной информации об ошибке вызовите функцию GetLastError .

Комментарии

Приложение может определить, поддерживает ли устройство операции с палитрой, вызвав функцию GetDeviceCaps с параметром RASTERCAPS .

Если приложение вызывает ResizePalette для уменьшения размера палитры, вхождения, оставшиеся в измененной палитре, не изменяются. Если приложение вызывает ResizePalette для увеличения размера палитры, то новым вхождениям в палитру присваивается черный цвет и их флаги устанавливаются в нуль.

См. также

GetDeviceCaps .

UpdateColors

Функция UpdateColors обновляет клиентскую область указанного контекста устройства, переустанавливая соответствие текущих цветов в клиентской области текущей реализованной логической палитры.

BOOL UpdateColors (

HDC hdc // дескриптор контекста устройства

);

Параметры

hdc - идентифицирует контекст устройства.

Возвращаемые значения

В случае успеха возвращается ненулевое значение.

В случае неудачи возвращается нуль. Для получения дополнительной информации вызовите функцию GetLastError .

Комментарии

Приложение может определить, поддерживает ли устройство операции с палитрой, вызвав функцию GetDeviceCaps с параметром RASTERCAPS .

Неактивное окно с реализованной логической палитрой может вызвать функцию UpdateColors в качестве альтернативы перерисовке его клиентской области при смене системной палитры.

Функция UpdateColors обычно обновляет клиентскую область быстрее, чем перерисовка данной области. Тем не менее, поскольку UpdateColors выполняет преобразование цвета, основанное на цвете каждого пикселя перед изменением системной палитры, вызов этой функции приводит к потере цветовой точности.

Функция должна вызываться сразу после получения приложением сообщения WM _ PALETTECHANGED .

См. также

GetDeviceCaps, RealizePalette .

Функции

Макросы

AdjustWindowRect

Функция AdjustWindowRect вычисляет необходимый размер оконного прямоугольника, основываясь на желаемом размере клиентского прямоугольника. Оконный прямоугольник может быть передан в функцию CreateWindowEx для создания окна, чья клиентская область имеет желаемый размер.

BOOL AdjustWindowRect (

LPRECT lpRect , // указатель на структуру с координатами

// клиентской области

DWORD dwStyle , // стили окна

BOOL bMenu // флаг наличия меню

);

Параметры

lpRect - указатель на структуру типа RECT , которая содержит координаты верхнего левого и нижнего правого углов клиентской области. После выполнения функции эта структура содержит координаты верхнего левого и нижнего правого углов окна, имеющего клиентскую область желаемого размера.

dwStyle - определяет стили окна, размер которого вычисляется.

bMenu - определяет наличие меню у окна.

Возвращаемые значения

В случае успеха возвращается ненулевое значение.

В случае неудачи возвращается нуль. Для получения дополнительной информации об ошибке вызовите функцию GetLastError .

Комментарии

Клиентский прямоугольник - это наименьший прямоугольник, который полностью содержит в себе клиентскую область окна. Оконный прямоугольник - это наименьший прямоугольник, который полностью содержит в себе само окно.

Функция AdjustWindowRect не добавляет дополнительного пространства, когда строка меню сворачивается в два или более рядов.

См. также

AdjustWindowRectEx, CreateWindowEx, RECT .

AdjustWindowRectEx

Функция AdjustWindowRectEx вычисляет необходимый размер прямоугольника окна с расширенным стилем, основываясь на желаемом размере клиентского прямоугольника. Оконный прямоугольник может быть передан в функцию CreateWindowEx для создания окна, чья клиентская область имеет желаемый размер.

BOOL AdjustWindowRectEx (

LPRECT lpRect , // указатель на структуру с координатами

// клиентской области

DWORD dwStyle , // стили окна

BOOL bMenu , // флаг наличия меню

DWORD dwExStyle // расширенный стиль

);

Параметры

lpRect - указатель на структуру типа RECT , которая содержит координаты верхнего левого и нижнего правого углов клиентской области. После выполнения функции эта структура содержит координаты верхнего левого и нижнего правого углов окна, имеющего клиентскую область желаемого размера.

dwStyle - определяет стили окна, размер которого вычисляется.

bMenu - определяет наличие меню у окна.

dwExStyle - определяет расширенный стиль окна, размер которого вычисляется.

Возвращаемые значения

В случае успеха возвращается ненулевое значение.

В случае неудачи возвращается нуль. Для получения дополнительной информации об ошибке вызовите функцию GetLastError .

Комментарии

Клиентский прямоугольник - это наименьший прямоугольник, который полностью содержит в себе клиентскую область окна. Оконный прямоугольник - это наименьший прямоугольник, который полностью содержит в себе само окно.

Функция AdjustWindowRectEx не добавляет дополнительного пространства, когда строка меню сворачивается в два или более рядов.

См . также

AdjustWindowRect, CreateWindowEx, RECT .

ArrangeIconicWindows

Функция ArrangeIconicWindows упорядочивает все минимизированные (в виде иконок) окна указанного родительского окна.

UINT ArrangeIconicWindows (

HWND hWnd // дескриптор родительского окна

);

Параметры

hWnd - идентифицирует родительское окно.

Возвращаемые значения

В случае успеха возвращается высота одного ряда иконок.

В случае неудачи возвращается нуль. Для получения дополнительной информации об ошибке вызовите функцию GetLastError .

Комментарии

Приложение, которое работает со своими минимизированными дочерними окнами, может использовать функцию ArrangeIconicWindows для упорядочивания иконок окон в родительском окне. Функция также может упорядочивать иконки окон на рабочем столе. Для получения дескриптора рабочего стола используйте функцию GetDesktopWindow .

Приложение отправляет сообщение WM _ MDIICONARRANGE MDI -окну для упорядочивания его минимизированных дочерних MDI -окон.

См. также

CloseWindow, GetDesktopWindow .

BeginDeferWindowPos

Функция BeginDeferWindowPos выделяет память для структуры, содержащей информацию о размере и положении для одного или более окон, и возвращает дескриптор этой структуры.

HDWP BeginDeferWindowPos (

int nNumWindows // количество окон

);

Параметры

nNumWindows - определяет начальное количество окон, для которых необходимо хранить информацию об их положении. Функция DeferWindowPos при необходимости увеличивает размер данной структуры.

Возвращаемые значения

В случае успеха возвращается идентификатор структуры.

В случае нехватки доступных ресурсов системы для структуры возвращается NULL .

Комментарии

Структура, содержащая информацию о размере и положении для одного или более окон, является внутренней структурой Windows . Приложение не может иметь к ней прямой доступ.

Функция DeferWindowPos заполняет структуру информацией об одном или нескольких окнах, подлежащих перемещению. Функция EndDeferWindowPos принимает дескриптор структуры и репозиционирует окна в соответствии с информацией из данной структуры.

Если одно из окон, описанных в структуре, имеет установленный флаг SWP _ HIDEWINDOW или SWP _ SHOWWINDOW, то не репозиционируется ни одно из окон.

Если Windows должна увеличить размер структуры по сравнению с начальным размером, задающимся значением параметра nNumWindows , но не может выделить достаточно памяти, то вся последовательность перемещений окон ( BeginDeferWindowPos, DeferWindowPos и EndDeferWindowPos ) заканчивается неудачей. Указанием максимально необходимого размера структуры приложение может выявить и обработать сбой в самом начале всего процесса.

См. также

DeferWindowPos, EndDeferWindowPos, SetWindowPos .

BringWindowToTop

Функция BringWindowToTop помещает указанное окно в вершину Z -последовательности. Если окно является окном верхнего уровня - оно активизируется. Если окно представляет собой дочернее окно - активизируется родительское окно верхнего уровня.

BOOL BringWindowToTop (

HWND hWnd // дескриптор окна

);

Параметры

hWnd - идентифицирует окно, помещаемое в вершину Z -последовательности.

Возвращаемые значения

В случае успеха возвращается ненулевое значение.

В случае неудачи возвращается нуль. Для получения дополнительной информации вызовите функцию GetLastError .

Комментарии

Используйте функцию BringWindowToTop для вывода окна, частично или полностью закрытого другими окнами, на передний план.

Результат вызова этой функции похож на результат вызова SetWindowPos для изменения позиции окна в Z -последовательности, но вызов BringWindowToTop не делает указанное окно окном верхнего уровня.

Если приложение не находится на переднем плане, и необходимо сделать его приложением переднего плана, вызовите функцию SetForegroundWindow .

См. также

SetWindowPos, SetActiveWindow, SetForegroundWindow .

CascadeWindows

Функция CascadeWindows располагает каскадом (каскадирует) указанные окна или дочерние окна указанного родительского окна.

WORD WINAPI CascadeWindows (

HWND hwndParent , // дескриптор родительского окна

UINT wHow , // типы окон, которые не подвергаются каскадированию

CONST RECT * lpRect , // прямоугольник, в которым каскадируются окна

UINT cKids , // количество каскадируемых окон

const HWND FAR *lpKids // массив дескрипторов окон

);

Параметры

hwndParent - идентифицирует родительское окно. Если значение этого параметра равно NULL, используется окно рабочего стола.

wHow - определяет флаг каскадирования. Доступно единственное значение: MDITILE _ SKIPDISABLED, предотвращающее каскадирование дочерних MDI окон, не принимающих ввод пользователя ( disabled windows ).

lpRect - указатель на структуру типа SMALL _ RECT , которая определяет прямоугольную область, в экранных координатах, внутри которой каскадируются окна. Значение параметра может быть равно NULL, тогда используется клиентская область родительского окна.

cKids - определяет число элементов в массиве, заданным параметром lpKids . Значение параметра игнорируется, если значение lpKids равно нулю.

lpKids - указатель на массив дескрипторов окон, идентифицирующих каскадируемые окна. Если значение этого параметра равно NULL, каскадируются дочерние окна указанного родительского окна (или окна рабочего стола).

Возвращаемые значения

В случае успеха возвращается количество упорядоченных окон.

В случае неудачи возвращается нуль.

См. также

SMALL_RECT .

ChildWindowFromPoint

Функция ChildWindowFromPoint определяет, какое из дочерних окон, принадлежащих родительскому окну, содержит указанную точку (если таки дочерние окна существуют).

HWND ChildWindowFromPoint (

HWND hWndParent , // дескриптор родительского окна

POINT Point // структура с координатами точки

);

Параметры

hWndParent - идентифицирует родительское окно.

Point - определяет структуру типа POINT , которая содержит клиентские координаты проверяемой точки.

Возвращаемые значения

В случае успеха возвращается дескриптор дочернего окна, которое содержит точку, даже если это дочернее окно скрыто или не принимает фокус ввода ( disabled ). Если точка лежит вне родительского окна, возвращается NULL . Если точка находится внутри родительского окна, но не лежит ни в одном из дочерних окон, возвращается дескриптор родительского окна.

Комментарии

Windows ведет внутренний список, содержащий дескрипторы дочерних окон, связанных с родительским окном. Порядок дескрипторов в этом списке зависит от Z -последовательности дочерних окон. Если указанная точка содержится более чем в одном дочернем окне, Windows возвращает дескриптор первого окна в списке, содержащего точку.

См. также

ChildWindowFromPointEx, POINT, WindowFromPoint .

ChildWindowFromPointEx

Функция ChildWindowFromPointEx определяет, какое из дочерних окон, принадлежащих родительскому окну, содержит указанную точку (если таки дочерние окна существуют). Функция может игнорировать невидимые, не принимающие фокус ввода ( disabled ) и прозрачные дочерние окна.

HWND ChildWindowFromPointEx (

HWND hwndParent , // дескриптор родительского окна

POINT pt , // структура с координатами точки

UINT uFlags // флаги игнорирования

);

Параметры

hWndParent - идентифицирует родительское окно.

Point - определяет структуру типа POINT , которая содержит клиентские координаты проверяемой точки.

uFlags - определяет, какие дочерние окна будут игнорироваться. Параметр может быть комбинацией следующих значений:

Возвращаемые значения

В случае успеха возвращается дескриптор дочернего окна, которое содержит точку и удовлетворяет условию, определенному значением параметра uFlags . Если точка лежит вне родительского окна или вызов функции завершился неудачей, возвращается NULL . Если точка находится внутри родительского окна, но не лежит ни в одном из дочерних окон, удовлетворяющих условию, определенному значением параметра uFlags , возвращается дескриптор родительского окна.

Комментарии

Windows ведет внутренний список, содержащий дескрипторы дочерних окон, связанных с родительским окном. Порядок дескрипторов в этом списке зависит от Z -последовательности дочерних окон. Если указанная точка содержится более чем в одном дочернем окне, Windows возвращает дескриптор первого окна в списке, содержащего точку и удовлетворяющего условию, определенному значением параметра uFlags .

См. также

ChildWindowFromPoint, POINT, WindowFromPoint .

CloseWindow

Функция CloseWindow минимизирует (но не разрушает) определенное окно.

BOOL CloseWindow (

HWND hWnd // дескриптор минимизируемого окна

);

Параметры

hWnd - идентифицирует минимизируемое окно.

Возвращаемые значения

В случае успеха возвращается ненулевое значение.

В случае неудачи возвращается нуль. Для получения дополнительной информации об ошибке вызовите функцию GetLastError .

Комментарии

Окно минимизируется путем уменьшения его до размеров иконки и помещения его в область иконок над панелью задач. Windows отображает иконку окна и его заголовок вместо самого окна. Для разрушения окна приложение должно использовать функцию DestroyWindow .

См. также

ArrangeIconicWindows, DestroyWindow, IsIconic, OpenIcon .

EndDeferWindowPos

Функция EndDeferWindowPos одновременно обновляет положение и размер одного или более окон в одном цикле обновления экрана.

BOOL EndDeferWindowPos (

HDWP hWinPosInfo // дескриптор внутренней структуры

);

Параметры

hWinPosInfo - идентифицирует внутреннюю структуру, содержащую информацию о размере и положении для одного или более окон. Эта внутренняя структура возвращается функцией BeginDeferWindowPos или более ранним вызовом функции DeferWindowPos .

Возвращаемые значения

В случае успеха возвращается ненулевое значение.

В случае неудачи возвращается нуль. Для получения дополнительной информации об ошибке вызовите функцию GetLastError .

Комментарии

Функция EndDeferWindowPos отправляет сообщения WM _ WINDOWPOSCHANGING и WM _ WINDOWPOSCHANGED каждому окну, идентифицируемому во внутренней структуре.

См. также

BeginDeferWindowPos, DeferWindowPos , WM_WINDOWPOSCHANGED, WM_WINDOWPOSCHANGING.

FindWindow

Функция FindWindow возвращает дескриптор окна верхнего уровня, чье имя класса и имя окна совпадают с заданными строками. Эта функция не ищет дочерние окна.

HWND FindWindow (

LPCTSTR lpClassName , // указатель на имя класса

LPCTSTR lpWindowName // указатель на имя окна

);

Параметры

lpClassName - указывает на завершающуюся нулем строку, определяющую имя класса или атом, идентифицирующий строку имени класса. Если этот параметр является атомом, то он должен быть глобальным атомом, созданным предыдущим вызовом функции GlobalAddAtom . 16-ти битное значение атома должно быть размещено в младшем слове lpClassName , старшее слово должно быть равно нулю.

lpWindowName - указывает на завершающуюся нулем строку, определяющую имя окна (заголовок окна). Если значение этого параметра равно NULL, то со значением lpWindowName совпадают имена всех окон.

Возвращаемые значения

В случае успеха функция возвращает дескриптор окна, которое имеет указанные имя класса и имя окна. В случае неудачи возвращается NULL. Для получения дополнительной информации об ошибке вызовите функцию GetLastError .

См . также

EnumWindows, FindWindowEx, GetClassName, GlobalAddAtom .

FindWindowEx

Функция FindWindowEx извлекает дескриптор окна, чье имя класса и имя окна совпадают с указанными строками. Функция также просматривает дочерние окна, начиная с того, дескриптор которого передан функции в качестве параметра hwndChildAfter .

HWND FindWindowEx (

HWND hwndParent , // дескриптор родительского окна

HWND hwndChildAfter , // дескриптор дочернего окна

LPCTSTR lpszClass , // указатель на имя класса

LPCTSTR lpszWindow // указатель на имя окна

);

Параметры

hwndParent - идентифицирует родительское окно, среди дочерних окон которого будет проводиться поиск.

Если значение параметра hwndParent равно NULL, функция использует рабочий стол Windows в качестве родительского окна. Функция проводит поиск среди окон, являющимися дочерними окнами рабочего стола.

hwndChildAfter - идентифицирует дочернее окно. Поиск начинается со следующего окна в Z- последовательности. Окно, указанное параметром hwndChildAfter , должно быть прямым дочерним окном указанного параметром hwndParent окна, а не порожденным окном.

Если значение параметра hwndChildAfter равно NULL, поиск начинается с первого дочернего окна.

Примечание: Если значения обоих параметров hwndParent и hwndChildAfter равны NULL, функция проводит поиск среди всех окон верхнего уровня.

lpszClass - указывает на завершающуюся нулем строку, определяющую имя класса или атом, идентифицирующий строку - имя класса. Если этот параметр является атомом, он должен быть глобальным атомом, созданным предыдущим вызовом функции GlobalAddAtom . Значение атома должно быть помещено в младшее слово lpszClass , старшее слово должно быть равно нулю.

lpszWindow - указывает на завершающуюся нулем строку, определяющую имя окна (заголовок окна). Если значение этого параметра равно NULL, то совпадающими со строкой считаются все имена окон.

Возвращаемые значения

В случае успеха возвращается дескриптор окна, которое имеет заданные имя класса и имя окна.

В случае неудачи возвращается NULL. Для получения дополнительной информации об ошибке вызовите функцию GetLastError .

См. также

EnumWindows, FindWindow, GetClassName, GlobalAddAtom .

GetClientRect

Функция GetClientRect возвращает координаты клиентской области окна. Клиентские координаты определяют верхний левый и правый нижний углы клиентской области. Поскольку клиентские координаты относительны левого угла клиентской области окна, то координатой верхнего левого угла является (0, 0).

BOOL GetClientRect (

HWND hWnd // дескриптор окна

LPRECT lpRect // адрес структуры для клиентских координат

);

Параметры

hWnd - идентифицирует окно, клиентские координаты которого возвращаются.

lpRect - указывает на структуру, получающую клиентские координаты. Члены left и top равны нулю. Члены right и bottom содержат ширину и высоту окна.

Возвращаемые значения

В случае успеха возвращается ненулевое значение.

В случае неудачи возвращается нуль. Для получения дополнительной информации об ошибке вызовите функцию GetLastError .

См . также

GetWindowRect, RECT.

SetWindowText

Функция SetWindowText изменяет текст заголовка (если заголовок существует) указанного окна. Если указанное окно является элементом управления, то изменяется текст этого элемента управления.

BOOL SetWindowText (

HWND hWnd , // дескриптор окна или элемента управления

LPCTSTR lpString // адрес строки

);

Параметры

hWnd - идентифицирует окно или элемент управления, чей текст изменяется.

lpString - указывает на завершающуюся нулем строку, используемую в качестве нового заголовка окна или текста элемента управления.

Возвращаемые значения

В случае успеха возвращается ненулевое значение.

В случае неудачи возвращается нуль. Для получения дополнительной информации об ошибке, вызовите функцию GetLastError

Комментарии

Функция SetWindowText отправляет сообщение WM_SETTEXT указанному окну или элементу управления. Тем не менее, если окно является окном списка, созданным с параметром WS_CAPTION, SetWindowText устанавливает текст для элемента управления, а не для элементов списка.

Функция SetWindowText не разворачивает символы табуляции ( ASCII -код 0 x 09). Символы табуляции отображаются как вертикальная черта (|).

См . также

GetWindowText , WM_SETTEXT.

CreateCaret

Функция CreateCaret создает новый внешний вид для системной каретки и присваивает владение кареткой указанному окну. Каретка может быть прямоугольником, линией или битовым образом.

BOOL CreateCaret (

HWND hWnd , // дескриптор окна-владельца

HBITMAP hBitmap , // дескриптор битового образа для каретки

int nWidth , // ширина каретки

int nHeight // высота каретки

);

Параметры

hWnd - идентифицирует окно, владеющее кареткой.

hBitmap - идентифицирует битовый образ, который определяет вид каретки. Если значение этого параметра равно NULL, каретка представляет собой сплошной прямоугольник. Если значение этого параметра равно ( HBITMAP ) 1, каретка представляет собой серый прямоугольник. Если значение этого параметра является дескриптором битового образа, то каретка представляет собой указанный битовый образ. Дескриптор битового образа должен быть создан функциями CreateBitmap, CreateDIBitmap или LoadBitmap .

Если значение hBitmap является дескриптором битового образа, CreateCaret игнорирует значения параметров nWidth и nHeight ; битовый образ задает свои собственные ширину и высоту.

nWidth - определяет ширину каретки в логических единицах. Если значение этого параметра равно нулю, ширина устанавливается в определяемую системой ширину рамки окна. Если значение hBitmap является дескриптором битового образа, CreateCaret игнорирует значение параметра nWidth .

nHeight - определяет высоту каретки в логических единицах. Если значение этого параметра равно нулю, высота устанавливается в определяемую системой высоту рамки окна. Если значение hBitmap является дескриптором битового образа, CreateCaret игнорирует значение параметра nHeight .

Возвращаемые значения

В случае успеха возвращается ненулевое значение.

В случае неудачи возвращается нуль. Для получения дополнительной информации об ошибке вызовите функцию GetLastError .

Комментарии

Значения параметров nWidth and nHeight определяют ширину и высоту каретки в логических единицах. Точные ширина и высота в пикселях зависят от режима отображения окна.

CreateCaret автоматически разрушает предыдущий вид каретки, если таковая есть, независимо от окна-владельца.

Пока приложение не вызовет функцию ShowCaret , каретка является скрытой.

Каретка является разделяемым ресурсом: в системе присутствует только одна каретка. Окно должно отображать каретку, только если оно активно или имеет фокус ввода с клавиатуры. Окно должно разрушить каретку перед тем, как оно потеряет фокус ввода с клавиатуры или станет неактивным.

Вы можете получить системные ширину и высоту окна, используя функцию GetSystemMetrics со значениями параметров SM _ CXBORDER и SM _ CYBORDER . Использование ширины или высоты рамки окна гарантирует, что каретка будет видна на экране с высоким разрешением.

См. также

CreateBitmap, CreateDIBitmap, DestroyCaret, GetSystemMetrics, HideCaret, LoadBitmap, ShowCaret .

DestroyCaret

Функция DestroyCaret разрушает текущую каретку, освобождает каретку от окна и удаляет изображение каретки с экрана.

Если каретка основана на растровом изображении, DestroyCaret не освобождает это изображение.

BOOL DestroyCaret ( VOID )

Параметры

Функция не имеет параметров.

Возвращаемые значения

В случае успеха возвращается ненулевое значение.

В случае неудачи возвращается нуль. Для получения дополнительной информации об ошибке вызовите функцию GetLastError .

Комментарии

DestroyCaret разрушает каретку только в том случае, ели окно в текущей задаче владеет ею. Если кареткой владеет окно, которое не принадлежит текущей задаче, DestroyCaret не выполняет никаких действий и возвращает FALSE.

Каретка является разделяемым ресурсом: в системе присутствует только одна каретка. Окно должно отображать каретку, только если оно активно или имеет фокус ввода с клавиатуры. Окно должно разрушить каретку перед тем, как оно потеряет фокус ввода с клавиатуры или станет неактивным.

См. также

CreateCaret, HideCaret, ShowCaret .

GetCaretBlinkTime

Функция GetCaretBlinkTime возвращает время мерцания каретки (время, требуемое для инвертирования пикселей каретки) в миллисекундах. Пользователь может установить это значение, используя Панель Управления.

UINT GetCaretBlinkTime ( VOID )

Параметры

Функция не имеет параметров.

Возвращаемые значения

В случае успеха возвращается время мерцания каретки в миллисекундах.

В случае неудачи возвращается нуль. Для получения дополнительной информации об ошибке вызовите функцию GetLastError .

См. также

SetCaretBlinkTime .

GetCaretPos

Функция GetCaretPos копирует позицию каретки, в клиентских координатах, в указанную структуру типа POINT .

BOOL GetCaretPos (

LPPOINT lpPoint // адрес структуры, получающей координаты

);

Параметры

lpPoint - указывает на структуру типа POINT , которая получает клиентские координаты каретки.

Возвращаемые значения

В случае успеха возвращается ненулевое значение.

В случае неудачи возвращается нуль. Для получения дополнительной информации об ошибке вызовите функцию GetLastError .

Комментарии

Позиция каретки всегда указывается в клиентских координатах окна, содержащего каретку.

См. также

SetCaretPos, POINT .

HideCaret

Функция HideCaret убирает каретку с экрана. Сокрытие каретки не разрушает ее текущей формы и не изменяет точки вставки.

BOOL HideCaret (

HWND hWnd // дескриптор окна с кареткой

);

Параметры

hWnd - идентифицирует окно, владеющее кареткой. Если значение этого параметра равно NULL, HideCaret ищет текущую задачу для окна, владеющего кареткой.

Возвращаемые значения

В случае успеха функция возвращает ненулевое значение. В случае неудачи возвращается нуль. Для получения дополнительной информации об ошибке вызовите функцию GetLastError .

Комментарии

HideCaret прячет каретку только в том случае, если указанное окно ею владеет. Если указанное окно не владеет кареткой, то HideCaret не выполняет никаких действий и возвращает FALSE.

Сокрытие каретки кумулятивно. Если ваше приложение вызывает HideCaret пять раз, то оно также должно пять раз вызвать ShowCaret для появления каретки.

См . также

CreateCaret, DestroyCaret, GetCaretPos, SetCaretPos, ShowCaret .

SetCaretBlinkTime

Функция SetCaretBlinkTime устанавливает время мерцания каретки в указанное число миллисекунд.

BOOL SetCaretBlinkTime (

UINT uMSeconds // время мерцания каретки, в миллисекундах

);

Параметры

uMSeconds - определяет новое время мерцания, в миллисекундах.

Возвращаемые значения

В случае успеха возвращается ненулевое значение.

В случае неудачи возвращается нуль. Для получения дополнительной информации об ошибке вызовите функцию GetLastError .

Комментарии

Пользователь может установить время мерцания через Панель Управления. Приложения должны "уважать" настройки, сделанные пользователем. Функция SetCaretBlinkTime должна использоваться приложением только в том случае, если приложение позволяет пользователю установить время мерцания каретки, наподобие Панели Управления.

Если вы изменили время мерцания, то запущенные позже приложения будут использовать новое значение, даже если вы восстанавливаете предыдущее значение времени мерцания при потере фокуса ввода, или когда ваше приложение становится неактивным. Это происходит из-за многопоточной среды, где деактивация вашего приложения не синхронизируется с активацией другого. Это позволяет системе активировать другое приложение, даже если текущее приложение зависло.

См. также

GetCaretBlinkTime .

SetCaretPos

Функция SetCaretPos перемещает каретку в заданную позицию. Если окно, которое владеет кареткой, было создано со стилем класса CS _ OWNDC, то указанные координаты зависят от режима отображения контекста устройства, связанного с окном.

BOOL SetCaretPos (

int X , // горизонтальная позиция

int Y // вертикальная позиция

);

Параметры

X - определяет новую x -координату каретки.

Y - определяет новую y -координату каретки.

Возвращаемые значения

В случае успеха возвращается ненулевое значение.

В случае неудачи возвращается нуль. Для получения дополнительной информации об ошибке вызовите функцию GetLastError .

Комментарии

SetCaretPos перемещает каретку вне зависимости от того, является ли каретка видимой, или нет.

Каретка является разделяемым ресурсом; в системе существует только один экземпляр каретки. Окно может установить положение каретки только в том случае, если оно владеет кареткой.

См. также

GetCaretPos, HideCaret, ShowCaret .

ShowCaret

Функция ShowCaret делает каретку видимой в ее текущей позиции на экране. Когда каретка становится видимой, она автоматически начинает мерцать.

BOOL ShowCaret (

HWND hWnd // дескриптор окна с кареткой

);

Параметры

hWnd - идентифицирует окно, владеющее кареткой. Если значение этого параметра равно NULL, ShowCaret ищет в текущей задаче окно, которое владеет кареткой.

Возвращаемые значения

В случае успеха возвращается ненулевое значение.

В случае неудачи возвращается нуль. Для получения дополнительной информации об ошибке вызовите функцию GetLastError .

Комментарии

ShowCaret показывает каретку только в случае, если указанное окно владеет кареткой, каретка имеет контур, и каретка не была скрыта два или более раз подряд. Если одно из этих условий нарушается, ShowCaret не производит никаких действий и возвращает FALSE.

Сокрытие каретки кумулятивно. Если ваше приложение вызывает HideCaret пять раз подряд, оно также должно вызвать ShowCaret пять раз подряд, прежде чем каретка станет видимой.

Каретка является разделяемым ресурсом: в системе присутствует только одна каретка. Окно должно отображать каретку, только если оно активно или имеет фокус ввода с клавиатуры.

См. также

CreateCaret, DestroyCaret, GetCaretPos, HideCaret, SetCaretPos .

CheckMenuItem

Функция CheckMenuItem устанавливает или снимает атрибут отметки пункта меню.

Функция CheckMenuItem была заменена функцией SetMenuItemInfo . Тем не менее, вы можете продолжать использовать CheckMenuItem , если вам не нужны дополнительные возможности SetMenuItemInfo .

DWORD CheckMenuItem (

HMENU hmenu , // дескриптор меню

UINT uIDCheckItem , // пункт меню

UINT uCheck // флаги пункта меню

);

Параметры

hmenu - идентифицирует интересующее меню.

uIDCheckItem - определяет пункт меню, чей атрибут отметки устанавливается, как определяется значением параметра uCheck .

uCheck - определяет флаги, которые управляют интерпретацией значения параметра uIDCheckItem и состоянием атрибута отметки пункта меню. Значение этого параметра должно представлять собой комбинацию MF_BYCOMMAND или MF_BYPOSITION и MF_CHECKED или MF_UNCHECKED.

Флаг MF _ BYCOMMAND является флагом по умолчанию, если флаг MF _ BYCOMMAND или MF _ BYPOSITION не установлен.

Возвращаемые значения

Возвращаемое значение идентифицирует предыдущее состояние пункта меню ( либо MF_CHECKED, либо MF_UNCHECKED). Если пункт меню не существует, возвращается 0 xFFFFFFFF .

Комментарии

Пункт в строке меню не может иметь отметку.

Значение параметра uIDCheckItem идентифицирует пункт меню, который либо открывает подменю, либо является командным пунктом меню. Для пункта меню, который открывает подменю, значение параметра uIDCheckItem должно указывать положение пункта. Для командного пункта меню, значение uIDCheckItem может определять как положение, так и идентификатор пункта меню.

См. также

EnableMenuItem, GetMenuCheckMarkDimensions, GetMenuItemID, SetMenuItemBitmaps, SetMenuItemInfo .

CreateMenu

Функция CreateMenu создает меню. Изначально меню пустое, но оно может быть заполнено пунктами меню, используя функции InsertMenuItem, AppendMenu и InsertMenu .

HMENU CreateMenu ( VOID )

Параметры

Функция не имеет параметров.

Возвращаемые значения

В случае успеха возвращается дескриптор созданного меню.

В случае неудачи возвращается NULL .

Комментарии

Ресурсы, связанные с меню, которое назначено окну, освобождаются автоматически. Если меню не назначено окну, приложение должно освободить ресурсы, связанные с меню, перед завершением приложения. Приложение освобождает ресурсы меню, вызывая функцию DestroyMenu .

Windows 95: Система может поддерживать максимум 16384 дескрипторов меню.

См. также

AppendMenu, CreatePopupMenu, DestroyMenu, InsertMenu, SetMenu, InsertMenuItem .

CreatePopupMenu

Функция CreatePopupMenu создает выпадающее меню (drop-down menu), подменю ( submenu ) или меню быстрого вызова ( shortcut menu ). Меню изначально пустое. Вы можете вставить или добавить пункты меню, используя функцию InsertMenuItem . Вы также можете использовать функцию InsertMenu для вставки пунктов меню и функцию AppendMenu для добавления пунктов меню.

HMENU CreatePopupMenu ( VOID )

Параметры

Функция не имеет параметров.

Возвращаемые значения

В случае успеха возвращается дескриптор созданного меню.

В случае неудачи возвращается NULL .

Комментарии

Приложение может добавить новое меню в существующее меню, или оно может отобразить меню быстрого вызова, используя функции TrackPopupMenu или TrackPopupMenuEx .

Ресурсы, связанные с меню, которое назначено окну, освобождаются автоматически. Если меню не назначено окну, приложение должно освободить ресурсы, связанные с меню, перед завершением приложения. Приложение освобождает ресурсы меню, вызывая функцию DestroyMenu .

Windows 95: Система может поддерживать максимум 16384 дескрипторов меню.

См. также

AppendMenu, CreateMenu, DestroyMenu, InsertMenu, SetMenu, TrackPopupMenu, TrackPopupMenuEx, InsertMenuItem .

DeleteMenu

Функция DeleteMenu удаляет пункт из заданного меню. Если пункт открывает меню или подменю, эта функция разрушает дескриптор меню или подменю и освобождает используемую ими память.

BOOL DeleteMenu (

HMENU hMenu , // дескриптор меню

UINT uPosition , // идентификатор или позиция пункта меню

UINT uFlags // флаг пункта меню

);

Параметры

hMenu - идентифицирует меню.

uPosition - задает удаляемый пункт меню, согласно значению параметра uFlags .

uFlags - определяет, каким образом интерпретируется значение параметра uPosition . Параметр uFlags должен принимать одно из следующих значений:

Возвращаемые значения

В случае успеха возвращается ненулевое значение.

В случае неудачи возвращается нуль. Для получения дополнительной информации об ошибке вызовите функцию GetLastError .

Комментарии

Приложение должно вызвать функцию DrawMenuBar при изменении меню, вне зависимости от того, находится ли меню в отображаемом окне или нет.

См . также

DrawMenuBar, RemoveMenu .

GetMenuCheckMarkDimensions

Функция является устаревшей. Используйте GetSystemMetrics со значениями CXMENUCHECK и CYMENUCHECK для извлечения размеров битового образа.

Функция GetMenuCheckMarkDimensions возвращает размеры битового образа отметки по умолчанию пункта меню. Windows отображает этот битовый образ в пункте меню. Перед вызовом функции SetMenuItemBitmaps для изменения битового образа отметки для пункта меню, приложение должно определить корректный размер образа, вызвав GetMenuCheckMarkDimensions .

LONG GetMenuCheckMarkDimensions ( VOID )

Параметры

Функция не имеет параметров.

Возвращаемые значения

Возвращаемое значение определяет высоту и ширину битового образа отметки по умолчанию в пикселях. Старшее слово содержит высоту, младше слово содержит ширину.

См. также

SetMenuItemBitmaps .

GetMenuItemCount

Функция GetMenuItemCount определяет количество пунктов в указанном меню.

int GetMenuItemCount (

HMENU hMenu // дескриптор меню

);

Параметры

hMenu - определяет дескриптор меню, для которого будет определяться количество пунктов .

Возвращаемые значения

В случае успеха возвращаемое значение определяет количество пунктов в меню.

В случае неудачи возвращается -1. Для получения дополнительной информации об ошибке вызовите функцию GetLastError .

См . также

GetMenuItemID .

GetMenuItemID

Функция GetMenuItemID извлекает идентификатор пункта меню, находящегося в указанной позиции в меню.

UINT GetMenuItemID (

HMENU hMenu , // дескриптор меню

int nPos // позиция пункта меню

);

Параметры

hMenu - идентифицирует меню, содержащее пункт меню, идентификатор которого извлекается.

nPos - определяет относительную позицию (отсчет начинается с нуля) пункта меню, идентификатор которого извлекается.

Возвращаемые значения

В случае успеха возвращается идентификатор данного пункта меню.

Если идентификатор меню равен NULL, или указанный пункт меню открывает подменю, возвращается 0 xFFFFFFFF .

См. также

GetMenuItemCount, GetMenuString .

GetMailslotInfo

Функция GetMailslotInfo извлекает информацию об указанном мэйлслоте.

BOOL GetMailslotInfo (

HANDLE hMailslot , // дескриптор мэйлслота

LPDWORD lpMaxMessageSize , // адрес максимального размера сообщения

LPDWORD lpNextSize , // адрес размера следующего сообщения

LPDWORD lpMessageCount , // адрес количества сообщений

LPDWORD lpReadTimeout // адрес тайм - аута чтения

);

Параметры

hMailslot - идентифицирует мэйлслот. Этот дескриптор должна создать функция CreateMailslot .

lpMaxMessageSize - когда функция возвращает управление, указывает на буфер, определяющий максимальный размер письма в байтах, допустимый для этого мэйлслота. Эта величина должна быть больше или равна значению параметра cbMaxMsg функции CreateMailslot , создавшей мэйлслот. Значение параметра может быть равно нулю.

lpNextSize - когда функция возвращает управление, указывает на буфер, определяющий размер следующего письма в байтах. Следующая величина имеет специальное значение:

MAILSLOT_NO_MESSAGE - следующее сообщение отсутствует.

Значение параметра может быть равно нулю.

lpMessageCount - когда функция возвращает управление, указывает на буфер, определяющий количество сообщений, ждущих прочтения. Значение параметра может быть равно нулю.

lReadTimeout - указывает на буфер, определяющий количество времени, в миллисекундах, которое операция чтения может ждать сообщения, записанного в мэйлслот, до наступления тайм-аута. Параметр заполняется, когда функция возвращает управление. Значение параметра может быть равно нулю.

Возвращаемые значения

В случае успеха возвращается ненулевое значение.

В случае неудачи возвращается нуль. Для получения дополнительной информации об ошибке вызовите функцию GetLastError .

См. также

CreateMailslot, SetMailslotInfo .

GetMenuState

Функция GetMenuState извлекает флаги меню, ассоциированные с указанным пунктом меню. Если пункт меню открывает подменю, функция также возвращает количество пунктов в подменю.

Функция GetMenuState заменена функцией GetMenuItemInfo . Вы, тем не менее, можете продолжать использовать функцию GetMenuState , если у вас нет необходимости в дополнительных возможностях функции GetMenuItemInfo .

UINT GetMenuState (

HMENU hMenu , // дескриптор меню

UINT uId , // запрашиваемый пункт меню

UINT uFlags // флаги меню

);

Параметры

hMenu - идентифицирует меню, которое содержит пункт, чьи флаги извлекаются.

uId - определяет пункт меню, для которого извлекаются флаги меню.

uFlags - определяет, как интерпретируется значение параметра uId . Параметр uFlags должен принимать одно из следующих значений:

Возвращаемые значения

Если указанного пункта меню не существует, возвращается 0 xFFFFFFFF .

Если пункт меню открывает подменю, младший байт возвращаемого значения содержит флаги меню, связанные с пунктом, а старший байт содержит число пунктов в подменю.

В остальных случаях возвращаемое значение является маской флагов меню. Ниже приведены флаги меню, связанные с пунктом меню:

См. также

GetMenu, GetMenuItemCount, GetMenuItemID, GetMenuItemInfo, GetMenuString .

SetMenuItemBitmaps

Функция SetMenuItemBitmaps связывает указанный битовый образ с пунктом меню. В зависимости от того, является ли пункт меню отмеченным или нет, Windows отображает соответствующий битовый образ в пункте меню.

BOOL SetMenuItemBitmaps (

HMENU hMenu , // дескриптор меню

UINT uPosition , // пункт меню для получения нового битового образа

UINT uFlags , // флаги пункта меню

HBITMAP hBitmapUnchecked , // дескриптор битового образа

// для неотмеченного состояния

HBITMAP hBitmapChecked // дескриптор битового образа

// для отмеченного состояния

);

Параметры

hMenu - идентифицирует меню, содержащее элемент, который получает новые битовые образы отмеченного и неотмеченного состояний.

uPosition - определяет подлежащий изменению пункт меню в соответствии со значением параметра uFlags .

uFlags - определяет, как интерпретируется значение параметра uPosition . Параметр uFlags должен быть одним из следующих значений:

hBitmapUnchecked - идентифицирует битовый образ, отображаемый, когда пункт меню не отмечен.

hBitmapChecked - идентифицирует битовый образ, отображаемый, когда пункт меню отмечен.

Возвращаемые значения

В случае успеха возвращается ненулевое значение.

В случае неудачи возвращается нуль. Для получения дополнительной информации об ошибке, вызовите функцию GetLastError .

Комментарии

Если значение параметра hBitmapUnchecked или hBitmapChecked равно NULL, Windows ничего не отображает в соответствующем пункте меню для соответствующего состояния. Если значения обоих параметров равны NULL, то Windows отображает стандартный битовый образ отметки, соответствующей отмеченному состоянию, и убирает битовый образ, когда пункт меню не отмечен.

При разрушении меню эти битовые образы не разрушаются: их должно разрушить приложение.

Windows NT : Функция GetMenuCheckMarkDimensions извлекает размеры отметки по умолчанию, используемой для пунктов меню. Эти значения используются для определения соответствующих размеров битовых образов, используемых функцией SetMenuItemBitmaps .

Windows 95: Функция GetMenuCheckMarkDimensions устарела . Используйте функцию GetsystemMetrics с параметрами CXMENUCHECK и CYMENUCHECK для извлечения размеров битовых образов.

См. также

GetMenu, GetMenuCheckMarkDimensions .

WindowProc

Функция WindowProc является определяемой приложением функцией обратного вызова, которая обрабатывает отправленные окну сообщения.

LRESULT CALLBACK WindowProc (

HWND hwnd , // дескриптор окна

UINT uMsg , // идентификатор сообщения

WPARAM wParam , // первый параметр сообщения

LPARAM lParam // второй параметр сообщения

);

Параметры

hWnd - идентифицирует окно, получающее сообщение.

uMsg - определяет сообщение.

wParam - определяет дополнительную информацию, зависящую от сообщения.

lParam - определяет дополнительную информацию, зависящую от сообщения.

Возвращаемые значения

Возвращаемое значение представляет собой результат обработки сообщения и зависит от сообщения.

Комментарии

WindowProc является "заполнителем" для имени определяемой приложением функции.

См. также

CallWindowProc, DefWindowProc, RegisterClass .

CharPrev

Функция CharPrev возвращает указатель на предшествующий символ в строке. Функция заменяет функцию AnsiPrev .

LPTSTR CharPrev (

LPCTSTR lpszStart , // указатель на первый символ

LPCTSTR lpszCurrent // указатель на текущий символ

);

Параметры

lpszStart - указатель на начало строки.

lpszCurrent - указатель на текущий символ в завершающейся нулем строке.

Возвращаемые значения

В случае успеха возвращается указатель на предшествующий символ в строке, или на первый символ в строке, если значения параметров lpszCurrent и lpszStart совпадают.

См. также

CharNext, CharPrevExA .

CharToOem

Функция CharToOem преобразует строку в набор символов ОЕМ. Эта функция заменяет функцию AnsiToOem .

BOOL CharToOem (

LPCTSTR lpszSrc , // указатель на преобразуемую строку

LPSTR lpszDst // указатель на буфер для преобразованной строки

);

Параметры

lpszSrc - указывает на завершающуюся нулем преобразуемую строку.

lpszDst - указывает на буфер для преобразованной строки. Если CharToOem используется как ANSI -функция, то можно установить параметр lpszDst на тот же адрес, что и параметр lpszSrc . Это не может быть осуществлено в случае использования CharToOem как Unicode -функции.

Возвращаемые значения

Всегда возвращается ненулевое значение.

См. также

CharToOemBuff, OemToChar, OemToCharBuff .

CharToOemBuff

Функция CharToOemBuff преобразует указанное количество символов в строке в набор символов ОЕМ. Эта функция заменяет функцию AnsiToOemBuff .

BOOL CharToOemBuff (

LPCTSTR lpszSrc , // указатель на преобразуемую строку

LPSTR lpszDst , // указатель на преобразованную строку

DWORD cchDstLength // длина преобразуемой строки в байтах

);

Параметры

lpszSrc - указывает на завершающуюся нулем преобразуемую строку.

lpszDst - указывает на буфер для преобразованной строки. Если CharToOemBuff используется как ANSI -функция, то можно установить параметр lpszDst на тот же адрес, что и параметр lpszSrc . Это не может быть осуществлено в случае использования CharToOemBuff как Unicode -функции.

cchDstLength - определяет количество символов для преобразования в строке, идентифицируемой значением параметра lpszSrc .

Возвращаемые значения

Всегда возвращается ненулевое значение.

См. также

CharToOem, OemToChar, OemToCharBuff .

EnumCodePagesProc

Функция EnumCodePagesProc является определяемой приложением функцией обратного вызова. Она вызывается в результате вызова функции EnumSystemCodePages , и получает указатель на строковый буфер, содержащий идентификатор кодовой страницы.

BOOL CALLBACK EnumCodePagesProc (

LPTSTR lpCodePageString // указатель на строку идентификатора

// кодовой страницы

);

Параметры

lpCodePageString - указатель на строковый буфер, содержащий завершающуюся нулем строку идентификатора кодовой страницы.

Возвращаемые значения

Для продолжения перечисления функция обратного вызова должна возвращать TRUE.

Для остановки перечисления, функция обратного вызова должна возвращать FALSE.

Комментарии

EnumCodePagesProc является "заполнителем" для имени определяемой приложением функции.

EnumCodePagesProc может выполнять любые желаемые действия.

Приложение регистрирует функцию EnumCodePagesProc , передавая ее адрес в функцию EnumSystemCodePages .

Значение типа CODEPAGE _ ENUMPROC является указателем на функцию EnumCodePagesProc .

См. также

EnumSystemCodePages .

GetACP

Функция GetACP возвращает идентификатор текущей кодовой страницы ANSI для системы.

UINT GetACP ( VOID )

Параметры

Функция не имеет параметров.

Возвращаемые значения

В случае успеха возвращается идентификатор текущей кодовой страницы ANSI для системы, или идентификатор по умолчанию, если текущая кодовая страница не установлена.

Комментарии

Ниже представлены идентификаторы кодовых страниц ANSI :

См. также

GetCPInfo, GetOEMCP .

GetCPInfo

Функция GetCPInfo извлекает информацию о любой действительной или доступной кодовой странице.

BOOL GetCPInfo (

UINT CodePage , // идентификатор кодовой страницы

LPCPINFO lpCPInfo // адрес структуры для информации

);

Параметры

CodePage - определяет идентификатор кодовой страницы, информация о которой извлекается. Вы можете указать идентификатор для любой установленной или доступной кодовой страницы, или вы можете указать одно из следующих предопределенных значений:

lpCPInfo - указатель на структуру типа CPINFO , которая получает информацию о кодовой странице.

Возвращаемые значения

В случае успеха возвращается ненулевое значение.

В случае неудачи возвращается нуль. Для получения дополнительной информации об ошибке вызовите функцию GetLastError .

Комментарии

Если кодовая страница не установлена или недоступна, GetCPInfo устанавливает значение последней ошибки в ERROR_INVALID_PARAMETER .

См. также

GetACP, GetOEMCP, CPINFO .

GetSystemDefaultLCID

Функция GetSystemDefaultLCID извлекает идентификатор системной локали по умолчанию.

LCID GetSystemDefaultLCID ( VOID )

Параметры

Функция не имеет параметров.

Возвращаемые значения

В случае успеха возвращается идентификатор системной локали по умолчанию.

См. также

GetLocaleInfo, GetUserDefaultLCID, MAKELCID .

GetThreadLocale

Функция GetThreadLocale возвращается текущую локаль вызывающего потока.

LCID GetThreadLocale ( VOID )

Параметры

Функция не имеет параметров.

Возвращаемые значения

Функция возвращает 32-битный идентификатор локали вызывающего потока.

Комментарии

При создании потока ему дается системная локаль потока по умолчанию. Система читает системную локаль потока по умолчанию из реестра при загрузке системы. Системная локаль потока по умолчанию может быть изменена в Панели управления.

См. также

SetThreadLocale, GetSystemDefaultLCID, GetUserDefaultLCID .

IsValidCodePage

Функция IsValidCodePage определяет, является ли действительной указанная кодовая страница.

BOOL IsValidCodePage (

UINT CodePage // проверяемая кодовая страница

);

Параметры

CodePage - определяет кодовую страницу, подлежащую проверке. Каждая кодовая страница идентифицируется уникальным номером.

Возвращаемые значения

Если кодовая страница действительна, возвращается ненулевое значение.

Если кодовая страница недействительна, возвращается нуль. Для получения дополнительной информации об ошибке вызовите функцию GetLastError .

Комментарии

Кодовая страница действительна только в том случае, если она установлена в системе.

Ниже приведены идентификаторы кодовых страниц ОЕМ:

См. также

GetACP, GetCPInfo, GetOEMCP .

SetThreadLocale

Функция SetThreadLocale устанавливает текущую локаль вызывающего потока.

BOOL SetThreadLocale (

LCID Locale // идентификатор локали

);

Параметры

Locale - определяет новую локаль для вызывающего потока. Значение этого параметра может быть идентификатором локали, созданным макросом MAKELCID , или одним из следующих предопределенных значений:

Возвращаемые значения

В случае успеха возвращается ненулевое значение.

В случае неудачи возвращается нуль. Для получения дополнительной информации об ошибке вызовите функцию GetLastError .

Комментарии

При создании потока ему дается системная локаль потока по умолчанию. Система читает системную локаль потока по умолчанию из реестра при загрузке системы. Системная локаль потока по умолчанию может быть изменена в Панели управления.

См. также

GetThreadLocale, GetSystemDefaultLCID, GetUserDefaultLCID .

ClipCursor

Функция ClipCursor заключает курсор в прямоугольную область на экране. Если последующая позиция курсора (установленная функцией SetCursorPos или мышью) лежит вне этой прямоугольной области, Windows автоматически устанавливает координату для сохранения курсора внутри области.

BOOL ClipCursor (

CONST RECT * lpRect // указатель на структуру с прямоугольником

);

Параметры

lprc - указывает на структуру типа RECT , которая содержит экранные координаты верхнего левого и нижнего правого углов ограничивающего прямоугольника. Если значение этого параметра равно NULL, курсор свободен в перемещении по экрану.

Возвращаемые значения

В случае успеха возвращается ненулевое значение.

В случае неудачи возвращается нуль. Для получения дополнительной информации об ошибке вызовите функцию GetLastError .

Комментарии

Курсор является разделяемым ресурсом. Если приложение ограничивает перемещение курсора, оно должно освободить курсор, используя функцию ClipCursor , перед передачей управления другому приложению.

Вызывающий процесс должен иметь доступ WINSTA _ READATTRIBUTES к оконной станции ( window station ). Разъяснение термина window station смотрите в описании функции CreateWindowStation .

См. также

GetClipCursor, GetCursorPos, RECT, SetCursorPos .

CopyCursor

Функция CopyCursor копирует курсор.

HCURSOR CopyCursor (

HCURSOR pcur // дескриптор копируемого курсора

);

Параметры

pcur - идентифицирует копируемый курсор.

Возвращаемые значения

В случае успеха возвращается дескриптор курсора-копии.

В случае неудачи возвращается NULL . Для получения дополнительной информации об ошибке вызовите функцию GetLastError .

Комментарии

CopyCursor позволяет приложению или динамически подключаемой библиотеке ( DLL ) получить дескриптор курсора, которым владеет другой модуль. Затем, если другой модуль завершил свою работу, приложение все еще будет иметь возможность использовать этот курсор.

См. также

CopyIcon, GetCursor, SetCursor, ShowCursor .

CreateCursor

Функция CreateCursor создает курсор, имеющий указанный размер, битовый шаблон и горячую точку.

HCURSOR CreateCursor (

HINSTANCE hInst , // дескриптор экземпляра приложения

int xHotSpot , // положение горячей точки по горизонтали

int yHotSpot , // положение горячей точки по вертикали

int nWidth , // ширина курсора

int nHeight , // высота курсора

CONST VOID * pvANDPlane , // указатель на массив битовой маски И

CONST VOID * pvXORPlane // указатель на массив битовой маски ИЛИ

);

Параметры

hInst - идентифицирует текущий экземпляр приложения, создающего курсор.

xHotSpot - определяет положение горячей точки курсора по горизонтали.

yHotSpot - определяет положение горячей точки курсора по вертикали.

nWidth - определяет ширину курсора в пикселях.

nHeight - определяет высоту курсора в пикселях.

pvANDplane - указывает на массив байт, содержащих значения битов для битовой маски И курсора, как в аппаратно-зависимом монохромном растровом изображении.

pvXORplane - указывает на массив байт, содержащих значения битов для битовой маски ИЛИ курсора, как в аппаратно-зависимом монохромном растровом изображении.

Возвращаемые значения

В случае успеха возвращается значение, идентифицирующее курсор.

В случае неудачи возвращается NULL . Для получения дополнительной информации об ошибке вызовите функцию GetLastError .

Комментарии

Значения параметров nWidth и nHeight должны указывать ширину и высоту, поддерживаемые текущим драйвером дисплея, потому что система не может создать курсоры других размеров. Для определения того, какие ширина и высота поддерживаются драйвером дисплея, вызовите функцию GetSystemMetrics , указав значения SM _ CXCURSOR и SM _ CYCURSOR .

Перед завершением приложение должно вызвать функцию DestroyCursor для освобождение системных ресурсов, связанных с курсором.

См. также

CreateIcon, DestroyCursor, GetModuleHandle, GetSystemMetrics, SetCursor .

DestroyCursor

Функция DestroyCursor разрушает курсор, созданный функцией CreateCursor , и освобождает память, занимаемую курсором. Не используйте функцию для разрушения курсора, который не был создан функцией CreateCursor .

BOOL DestroyCursor (

HCURSOR hCursor // дескриптор разрушаемого курсора

);

Параметры

hCursor - идентифицирует разрушаемый курсор. Курсор не должен использоваться.

Возвращаемые значения

В случае успеха возвращается ненулевое значение.

В случае неудачи возвращается нуль. Для получения дополнительной информации об ошибке вызовите функцию GetLastError .

См. также

CreateCursor .

GetClipCursor

Функция GetClipCursor извлекает экранные координаты прямоугольной области, в которую заключен курсор.

BOOL GetClipCursor (

LPRECT lpRect // адрес структуры для прямоугольника

);

Параметры

lpRect - указываете на структуру типа RECT , которая получает экранные координаты прямоугольника. Структура получает размеры экрана, если курсор не заключен в прямоугольник.

Возвращаемые значения

В случае успеха возвращается ненулевое значение.

В случае неудачи возвращается нуль. Для получения дополнительной информации об ошибке вызовите функцию GetLastError .

Комментарии

Курсор является разделяемым ресурсом. Если приложение заключает курсор в прямоугольную область функцией ClipCursor , оно затем должно освободить курсор, используя функцию ClipCursor , перед тем, как уступить курсор другому приложению.

Вызывающий процесс должен иметь доступ WINSTA _ READATTRIBUTES к оконной станции ( window station ). Разъяснение термина window station смотрите в описании функции CreateWindowStation .

См. также

ClipCursor, GetCursorPos, RECT .

GetCursor

Функция GetCursor возвращает дескриптор текущего курсора.

HCURSOR GetCursor ( VOID )

Параметры

Функция не имеет параметров.

Возвращаемые значения

В случае успеха функция возвращает дескриптор текущего курсора.

Если курсора нет, возвращает NULL.

См. также

SetCursor .

GetCursorPos

Функция GetCursorPos извлекает положение курсора в экранных координатах.

BOOL GetCursorPos (

LPPOINT lpPoint // адрес структуры для положения курсора

);

Параметры

lpPoint - указывает на структуру типа POINT , которая получает экранные координаты курсора.

Возвращаемые значения

В случае успеха возвращается ненулевое значение.

В случае неудачи возвращается нуль. Для получения дополнительной информации об ошибке вызовите функцию GetLastError .

Комментарии

Положение курсора всегда дается в экранных координатах и не подвержено воздействию режима отображения окна, которое содержит курсор.

Вызывающий процесс должен иметь доступ WINSTA _ READATTRIBUTES к оконной станции ( window station ). Разъяснение термина window station смотрите в описании функции CreateWindowStation .

См. также

ClipCursor, POINT, SetCursor, SetCursorPos, ShowCursor .

LoadCursor

Функция LoadCursor загружает указанный ресурс курсора из исполняемого (. EXE ) файла, связанного с экземпляром приложения.

HCURSOR LoadCursor (

HINSTANCE hInstance , // дескриптор экземпляра приложения

LPCTSTR lpCursorName // строка с именем курсора или

// идентификатор ресурса

);

Параметры

hInstance - идентифицирует экземпляр модуля, чей исполняемый файл содержит курсор.

lpCursorName - указывает на завершающуюся нулем строку, которая сдержит имя ресурса загружаемого курсора. В качестве альтернативы, значение этого параметра может содержать идентификатор ресурса в младшем слове и нуль в старшем. Используйте макрос MAKEINTRESOURCE для создания данного значения.

Для использования предопределенных курсоров Windows установите значение параметра hInstance в NULL, а значение параметра lpCursorName в одно из следующих значений:

В случае успеха возвращается дескриптор загруженного курсора.

В случае неудачи возвращается NULL . Для дополнительной информации об ошибке вызовите функцию GetLastError .

Комментарии

LoadCursor загружает ресурс курсора только в том случае, если он еще не загружен. В противном случае функция извлекает дескриптор существующего ресурса. Функция возвращает действительный дескриптор курсора, только если значение параметра lpCursorName указывает на ресурс курсора. Если оно указывает на любой другой тип ресурса, отличный от курсора (например, на иконку), возвращается не NULL, хотя возвращаемое значение и не будет действительным дескриптором курсора.

LoadCursor просматривает ресурс на предмет курсора, наиболее подходящего для текущего устройства изображения. Ресурс курсора может быть цветным или монохромным битовым образом.

См. также

LoadImage, MAKEINTRESOURCE, SetCursor, SetCursorPos, ShowCursor .

LoadCursorFromFile

Функция LoadCursorFromFile создает курсор, основанный на данных, содержащихся в файле. Файл задается его именем или идентификатором системного курсора. Функция возвращает дескриптор созданного курсора. Файлы, содержащие данные, могут быть либо файлами курсоров (. CUR ), либо файлами анимированных курсоров (. ANI ).

HCURSOR LoadCursorFromFile (

LPCTSTR lpFileName // указатель на имя файла с курсором или

// идентификатор системного курсора

);

Параметры

lpFileName - указывает на источник файловых данных, используемых для создания курсора. Файлы, должны быть либо файлами курсоров (. CUR ), либо файлами анимированных курсоров (. ANI ).

Если старшее слово lpFileName не равно нулю, то значение lpFileName указывает на строку с полным именем файла, содержащего данные для курсора.

Если старшее слово lpFileName равно нулю, нижнее слово представляет собой идентификатор системного курсора. Затем функция просматривает секцию [ Cursors ] в файле WIN . INI на предмет файла, связанного с именем указанного системного курсора. Ниже приводится список имен системных курсоров и идентификаторов:

Например, если в WIN . INI содержится следующее:

[Cursors]

Arrow = "arrow.ani"

то вызов LoadCursorFromFile (( LPWSTR ) OCR _ NORMAL ) заставит функцию LoadCursorFromFile получить данные из файла ARROW . ANI . Если WIN . INI не содержит строки для указанного системного курсора, вызов функции завершится неудачей и функция вернет NULL .

Возвращаемые значения

В случае успеха возвращается дескриптор нового курсора.

В случае неудачи возвращается NULL . Для получения дополнительной информации об ошибке вызовите функцию GetLastError . GetLastError может вернуть следующее значение: ERROR _ FILE _ NOT _ FOUND - указанный файл не может быть найден.

См. также

LoadCursor, SetCursor, SetSystemCursor .

SetCursor

Функция SetCursor устанавливает курсор.

HCURSOR SetCursor (

HCURSOR hCursor // дескриптор курсора

);

Параметры

hCursor - идентифицирует курсор. Курсор должен быть создан функцией CreateCursor или загружен функциями LoadCursor или LoadImage . Если значение этого параметра равно NULL, курсор убирается с экрана.

Windows 95: Ширина и высота курсора должны быть значениями, возвращаемые функцией GetSystemMetrics для параметров SM _ CXCURSOR и SM _ CYCURSOR . В дополнение, глубина цвета курсора должна совпадать с глубиной цвета экрана, или курсор будет монохромным.

Возвращаемые значения

Возвращается дескриптор предыдущего курсора, если таковой имеется.

Если предыдущего курсора нет, возвращается NULL .

Комментарии

Курсор устанавливается, только если он отличен от предыдущего курсора. В противном случае, функция возвращает управление немедленно.

Курсор является разделяемым ресурсом. Окно должно устанавливать курсор только в том случае, если он находится в его клиентской области и окно перехватывает ввод мыши. В системах без мыши, окно должно восстанавливать предыдущий курсор перед тем, как он покинет клиентскую область окна.

Если ваше приложение должно устанавливать курсор, когда он находится в окне, будьте уверены, что курсор класса для указанного класса окна установлен в NULL . Если курсор класса не NULL, система восстанавливает курсор класса каждый раз, когда перемещается мышь.

Курсор не отображается на экране, если внутренний счетчик отображений меньше нуля. Это происходит, если приложение использует функцию ShowCursor для скрытия курсора большее число раз, чем оно показывает курсор.

См. также

CreateCursor, GetCursor, GetSystemMetrics, LoadCursor, LoadImage, SetCursorPos, ShowCursor .

SetCursorPos

Функция SetCursorPos перемещает курсор в указанные экранные координаты. Если новые координаты находятся вне экранного прямоугольника, установленного последним вызовом функции ClipCursor , Windows автоматически устанавливает координаты, так что курсор остается внутри прямоугольника.

BOOL SetCursorPos (

int X , // горизонтальное положение

int Y // вертикальное положение

);

Параметры

X - определяет новую x -координату курсора в экранных координатах.

Y - определяет новую y -координату курсора в экранных координатах.

Возвращаемые значения

В случае успеха возвращается ненулевое значение.

В случае неудачи возвращается нуль. Для дополнительной информации об ошибке вызовите функцию GetLastError .

Комментарии

Курсор является разделяемым ресурсом. Окно должно перемещать курсор, только если он находится в его клиентской области.

Вызывающий процесс должен иметь доступ WINSTA _ READATTRIBUTES к оконной станции ( window station ). Разъяснение термина window station смотрите в описании функции CreateWindowStation .

См. также

ClipCursor, GetCursorPos, SetCaretPos, SetCursor, ShowCursor .

SetSystemCursor

Функция SetSystemCursor заменяет содержимое системного курсора с указанным id содержимым курсора, определенным значением параметра hcur и затем разрушает hcur . Эта функция позволяет приложению изменять системные курсоры.

BOOL SetSystemCursor (

HCURSOR hcur , // устанавливает указанный системный курсор в содержимое

// данного курсора, а затем разрушает этот курсор

DWORD id // системный курсор, заданный его идентификатором

);

Параметры

hcur - дескриптор курсора. Функция заменяет содержимое системного курсора с указанным id содержимым курсора, определенным значением параметра hcur и затем разрушает hcur , вызывая DestroyCursor ( hcur ).

id - идентификатор системного курсора.

Ниже приведен список идентификаторов системных курсоров:

Возвращаемые значения

В случае успеха возвращается ненулевое значение.

В случае неудачи возвращается нуль. Для получения дополнительной информации об ошибке вызовите функцию GetLastError .

См. также

DestroyCursor, LoadCursor, LoadCursorFromFile, SetCursor .

ShowCursor

Функция ShowCursor отображает или скрывает курсор.

int ShowCursor (

BOOL bShow // флаг видимости курсора

);

Параметры

bShow - определяет, инкрементируется или декрементируется внутренний счетчик отображения. Если значение bShow равно TRUE - внутренний счетчик отображения увеличивается на единицу. Если значение bShow равно FALSE - внутренний счетчик отображения уменьшается на единицу.

Возвращаемые значения

Возвращаемое значение определяет новый счетчик отображения.

Комментарии

Функция устанавливает внутренний счетчик, определяющий, должен ли быть отображен курсор. Курсор отображается лишь в том случае, если счетчик отображения больше нуля или равен нулю. Если в системе установлена мышь, то начальное значение счетчика равно 0. Если мышь в системе не установлена, начальное значение счетчика равно -1.

См. также

ClipCursor, GetCursorPos, SetCursor, SetCursorPos .

Beep

Функция Beep генерирует простые звуки на динамике компьютера. Функция синхронная; она не возвращает управления до тех пор, пока звук не прекратится.

BOOL Beep (

DWORD dwFreq , // частота звука в герцах

DWORD dwDuration // продолжительность звука в миллисекундах

);

Параметры

Windows NT :

dwFreq - определяет частоту звука в герцах. Значение параметра должно лежать в диапазоне от 37 до 32,767 (0 x 25 до 0 x 7 FFF ).

Windows 95:

Значение параметра игнорируется.

Windows NT :

dwDuration - определяет продолжительность звука в миллисекундах.

Windows 95:

Значение параметра игнорируется.

Возвращаемые значения

В случае успеха возвращается ненулевое значение.

В случае неудачи возвращается нуль. Для получения дополнительной информации об ошибке вызовите функцию GetLastError .

Комментарии

Windows 95: функция Beep игнорирует значения параметров dwFreq и dwDuration . На компьютерах со звуковой картой функция воспроизводит звуковое событие по умолчанию. На компьютерах без звуковой карты функция воспроизводит стандартный системный звук через динамик компьютера.

См. также

MessageBeep .

BeginUpdateResource

Функция BeginUpdateResource возвращает дескриптор, который может быть использован функцией UpdateResource для добавления, удаления или замены ресурсов в исполняемом файле.

HANDLE BeginUpdateResource (

LPCTSTR pFileName , // имя файла, в котором будут обновляться ресурсы

BOOL bDeleteExistingResources // опция удаления

);

Параметры

pFileName - указатель на завершающуюся нулем строку, которая определяет исполняемый файл, в котором необходимо обновить ресурсы. Приложение должно иметь возможность получить разрешение на запись в файл; оно не может выполняться в этот момент. Если значение pFileName не определяет полный путь, Windows ищет файл в текущей директории.

bDeleteExistingResources - определяет, удалять ли существующие ресурсы, находящиеся в файле, определяемом значением параметра pFileName . Если значение параметра bDeleteExistingResources равно TRUE, существующие ресурсы удаляются и обновленный исполняемый файл содержит только ресурсы, добавленные функцией UpdateResource . Если значение параметра bDeleteExistingResources равно FALSE, обновленный исполняемый файл содержит существующие ресурсы до тех пор, пока они не будут явно удалены или заменены функцией UpdateResource .

Возвращаемые значения

В случае успеха возвращается дескриптор, который может быть использован в функциях UpdateResource и EndUpdateResource .

Возвращается NULL, если указанный файл не является исполняемым файлом, исполняемый файл уже загружен, файл не существует или файл не может быть открыт для записи. Для получения дополнительной информации об ошибке вызовите функцию GetLastError .

См. также

EndUpdateResource, UpdateResource .

FindResource

Функция FindResource определяет местоположение ресурса с указанным типом и именем в указанном модуле.

HRSRC FindResource (

HMODULE hModule , // дескриптор модуля ресурса

LPCTSTR lpName , // указатель на имя ресурса

LPCTSTR lpType // указатель на тип ресурса

);

Параметры

hModule - дескриптор модуля, чей исполняемый файл содержит ресурс. Значение параметра, равное NULL, определяет дескриптор модуля, связанного с загрузочным файлом, который использовала операционная система для создания текущего процесса.

lpName - определяет имя ресурса. Для дополнительной информации смотрите раздел "Комментарии".

lpType - определяет тип ресурса. Для дополнительной информации смотрите раздел "Комментарии". Для стандартных типов ресурсов этот параметр может принимать одно из следующих значений:

Возвращаемые значения

В случае успеха возвращается дескриптор блока с информацией об указанном ресурсе. Для получения дескриптора ресурса передайте этот дескриптор в функцию LoadResource .

В случае неудачи возвращается NULL . Для получения дополнительной информации об ошибке вызовите функцию GetLastError .

Комментарии

Если старшее слово значения параметра lpName или lpType равно нулю, младшее слово определяет целочисленный идентификатор имени или типа указанного ресурса. В противном случае, оба значения этих параметров представляют собой длинные указатели на завершающиеся нулем строки. Если первый символ строки равен '#', оставшиеся символы представляют собой десятичное число, которое определяет целочисленный идентификатор имени или типа ресурса. Например, строка "#258" представляет собой целочисленный идентификатор 258.

Приложение может уменьшить количество памяти, необходимое ресурсу, обращаясь к нему по целочисленному идентификатору вместо имени.

Приложение может использовать FindResource для поиска ресурса любого типа, но эта функция должна быть использована только в том случае, если приложение должно иметь доступ к двоичным данным ресурсов, когда оно впоследствии вызывает функции LoadLibrary и LockResource .

Для немедленного использования ресурса приложение должно использовать одну из следующих функций для поиска и загрузки ресурса:

Например, приложение должно и c пользовать функцию LoadIcon для загрузки иконки для ее отображения на экране. Тем не менее, приложение должно использовать функции FindResource и LoadResource , если оно загружает иконку для копирования ее данных в другое приложение.

См. также

FindResourceEx, FormatMessage, LoadAccelerators, LoadBitmap, LoadCursor, LoadIcon, LoadMenu, LoadResource, LoadString, LockResource, SizeofResource .

FindResourceEx

Функция FindResourceEx определяет местоположение ресурса с указанным типом, именем и языком в указанном модуле.

HRSRC FindResourceEx (

HMODULE hModule , // дескриптор модуля ресурса

LPCTSTR lpName , // указатель на имя ресурса

LPCTSTR lpType // указатель на тип ресурса

WORD wLanguage // язык ресурса

);

Параметры

hModule - дескриптор модуля, чей исполняемый файл содержит ресурс. Значение параметра, равное NULL, определяет дескриптор модуля, связанного с загрузочным файлом, который использовала операционная система для создания текущего процесса.

lpName - определяет имя ресурса. Для дополнительной информации смотрите раздел "Комментарии".

lpType - определяет тип ресурса. Для дополнительной информации смотрите раздел "Комментарии". Для стандартных типов ресурсов этот параметр может принимать одно из следующих значений:

wLanguage - определяет язык ресурса. Если значение этого параметра равно MAKELANGID ( LANG_NEUTRAL, SUBLANG_NEUTRAL ), используется текущий язык, ассоциированный с вызывающим потоком.

Для указания языка, отличного от текущего, используйте макрос MAKELANGID .

Возвращаемые значения

В случае успеха возвращается дескриптор блока с информацией об указанном ресурсе. Для получения дескриптора ресурса передайте этот дескриптор в функцию LoadResource .

В случае неудачи возвращается NULL . Для получения дополнительной информации об ошибке вызовите функцию GetLastError .

Комментарии

Если старшее слово значения параметра lpName или lpType равно нулю, младшее слово определяет целочисленный идентификатор имени или типа указанного ресурса. В противном случае, оба значения этих параметров представляют собой длинные указатели на завершающиеся нулем строки. Если первый символ строки равен '#', оставшиеся символы представляют собой десятичное число, которое определяет целочисленный идентификатор имени или типа ресурса. Например, строка "#258" представляет собой целочисленный идентификатор 258.

Приложение может уменьшить количество памяти, необходимое ресурсу, обращаясь к нему по целочисленному идентификатору вместо имени.

Приложение может использовать FindResourceEx для поиска ресурса любого типа, но эта функция должна быть использована только в том случае, если приложение должно иметь доступ к двоичным данным ресурсов, когда оно впоследствии вызывает функции LoadLibrary и LockResource .

Для немедленного использования ресурса приложение должно использовать одну из следующих функций для поиска и загрузки ресурса:

Например, приложение должно использовать функцию LoadIcon для загрузки иконки для ее отображения на экране. Тем не менее, приложение должно использовать функции FindResource и LoadResource , если оно загружает иконку для копирования ее данных в другое приложение.

См . также

FindResource, FormatMessage, LoadAccelerators, LoadBitmap, LoadCursor, LoadIcon, LoadMenu, LoadResource, LoadString, LockResource, SizeofResource .

BrowseCallbackProc

Функция BrowseCallbackProc представляет собой определяемую приложением функцию обратного вызова, используемую совместно с функцией SHBrowseForFolder . Диалоговое окно выбора папки вызывает эту функцию для уведомления о событиях. Тип BFFCALLBACK определяет указатель на эту функцию обратного вызова.

int BrowseCallbackProc (

HWND hwnd ,

UINT uMsg ,

LPARAM lParam ,

LPARAM lpData

);

Параметры

hwnd - дескриптор диалогового окна. Функция обратного вызова может отправлять окну следующие сообщения:

uMsg - идентифицирует событие. Может принимать одно из следующих значений:

lParam - зависящее от сообщения значение.

lpData - определяемое приложением значение, которое было указано в члене lParam структуры типа BROWSEINFO .

Возвращаемые значения

Функция возвращает нуль.

См. также

BROWSEINFO .

SHAddToRecentDocs

Добавляет документ в список недавно использовавшихся документов или очищает список. Пользователь может получить доступ к списку через меню Пуск ( Start ) панели задач Windows .

WINSHELLAPI void WINAPI SHAddToRecentDocs (

UINT uFlags ,

LPCVOID pv

);

Параметры

uFlags - флаг, определяющий значение параметра pv . Может принимать одно из следующих значений:

SHARD_PATH - pv является адресом строки, содержащей путь и имя файла;

SHARD_PIDL - pv является адресом списка идентификаторов элемента.

pv - указатель на буфер, содержащий путь и имя файла документа, или адрес структуры ITEMIDLIST , содержащей список идентификаторов элемента, однозначно определяющих документ. Если значение этого параметр равно NULL, то функция очищает список недавно использовавшихся документов.

Возвращаемые значения

Функция не возвращает значения.

SHBrowseForFolder

Функция SHBrowseForFolder отображает диалоговое окно, позволяющее пользователю выбрать папку пространства имен.

WINSHELLAPI LPITEMIDLIST WINAPI SHBrowseForFolder (

LPBROWSEINFO lpbi

);

Параметры

lpbi - указатель на структуру типа BROWSEINFO , которая содержит информацию, используемую для отображения диалогового окна.

Возвращаемые значения

Возвращается указатель на список идентификаторов элементов, который определяет местоположение выбранной папки относительно корня пространства имен. Если пользователь в диалоговом окне нажал клавишу Cancel, возвращается NULL .

Вызывающее приложение ответственно за освобождение возвращаемого списка идентификаторов.

См. также

BROWSEINFO.

SHFileOperation

Выполняет операцию копирования, перемещения, переименования или удаления над объектом файловой системы.

WINSHELLAPI int WINAPI SHFileOperation (

LPSHFILEOPSTRUCT lpFileOp

);

Параметры

lpFileOp - указатель на структуру типа SHFILEOPSTRUCT , содержащую информацию, необходимую функции для выполнения операции.

Возвращаемые значения

В случае успеха возвращается нуль, ненулевое значение в противном случае.

См. также

SHFILEOPSTRUCT.

SHFreeNameMappings

Освобождает объект отображения имени файла (filename mapping object), извлекаемый функцией SHFileOperation .

WINSHELLAPI void WINAPI SHFreeNameMappings (

HANDLE hNameMappings

);

Параметры

hNameMappings - дескриптор освобождаемого объекта отображения имени файла.

Возвращаемые значения

Функция не возвращает значения.

SHGetDesktopFolder

Функция SHGetDesktopFolder возвращает интерфейс IShellFolder для папки рабочего стола, которая является корнем пространства имен пользовательского интерфейса ( shell ).

WINSHELLAPI HRESULT WINAPI SHGetDesktopFolder (

LPSHELLFOLDER *ppshf

);

Параметры

ppshf - адрес, получающий указатель на интерфейс IShellFolder для папки рабочего стола. Вызывающее приложение ответственно за освобождение интерфейса вызовом метода Release .

Возвращаемые значения

В случае успеха возвращает NOERROR или OLE -определенную ошибку в противном случае.

См. также

IShellFolder .

SHGetInstanceExplorer

Функция SHGetInstanceExplorer извлекает адрес интерфейса IUnknown Explorer'а ( Проводника ).

WINSHELLAPI HRESULT WINAPI SHGetInstanceExplorer (

IUnknown * ppunk

);

Параметры

ppunk - указатель на переменную, получающую адрес интерфейса IUnknown Explorer 'а.

Возвращаемые значения

В случае успеха возвращается NOERROR .

В случае неудачи возвращается E _ FAIL .

SHGetMalloc

Функция SHGetMalloc извлекает указатель на интерфейс IMalloc оболочки. Расширение оболочки должно использовать этот интерфейс для выделения памяти, позднее освобождаемой оболочкой.

HRESULT SHGetMalloc (

LPMALLOC * ppMalloc

);

Параметры

ppMalloc - адрес переменной, которая получает адрес интерфейса IMalloc оболочки.

Возвращаемые значения

В случае успеха возвращается NOERROR или E _ FAIL в противном случае.

SHLoadInProc

Функция SHLoadInProc создает экземпляр указанного класса объекта внутри контекста процесса пользовательского интерфейса.

WINSHELLAPI HRESULT WINAPI SHLoadInProc (

REFCLSID rclsid

);

Параметры

rclsid - CLSID класса объекта, экземпляр которого создается.

Возвращаемые значения

В случае успеха возвращает NOERROR или OLE -определенную ошибку в противном случае.

CancelDC

Функция CancelDC отменяет любую незаконченную операцию на указанном контексте устройства.

BOOL CancelDC (

HDC hdc // дескриптор контекста устройства

);

Параметры

hdc - идентифицирует контекст устройства.

Возвращаемые значения

В случае успеха возвращается ненулевое значение.

В случае неудачи возвращается нуль.

Комментарии

Функция CancelDC используется многопоточными приложениями для отмены протяженных во времени операций рисования. Если поток A инициирует такую операцию рисования, поток В может ее отменить, вызвав эту функцию.

Результаты не определены, если во время вызова этой функции не было выполняющейся операции рисования.

См. также

CreateThread, GetCurrentThread .

CreateCompatibleDC

Функция CreateCompatibleDC создает контекст устройства в памяти, совместимый с указанный контекстом.

HDC CreateCompatibleDC (

HDC hdc // дескриптор контекста устройства

);

Параметры

hdc - идентифицирует контекст устройства. Если значение этого параметра равно NULL, функция создает контекст устройства в памяти, совместимый с текущим экраном приложения.

Возвращаемые значения

В случае успеха возвращается дескриптор контекста устройства в памяти.

В случае неудачи возвращается NULL .

Комментарии

Перед тем, как приложение сможет использовать контекст устройства в памяти для операций рисования, оно должно выбрать в контекст устройства битовый образ с корректной шириной и высотой. Как только битовый образ выбран, контекст устройства может быть использован для подготовки изображений, которые будут скопированы на экран или принтер.

Функция CreateCompatibleDC может быть использована только с теми устройствами, которые поддерживают растровые операции. Приложение может узнать о поддержке этих операций, вызвав функцию GetDeviceCaps .

В случае, если в контексте устройства отпала необходимость, вызовите функцию DeleteDC для его удаления.

См. также

CreateCompatibleBitmap, DeleteDC, GetDeviceCaps .

DeleteDC

Функция DeleteDC удаляет заданный контекст устройства.

BOOL DeleteDC (

HDC hdc // дескриптор контекста устройства

);

Параметры

hdc - идентифицирует контекст устройства.

Возвращаемые значения

В случае успеха возвращается ненулевое значение.

В случае неудачи возвращается нуль.

Комментарии

Приложение не должно удалять контекст устройства, чей дескриптор был получен вызовом функции GetDC . Вместо этого приложение должно вызвать функцию ReleaseDC для освобождения контекста устройства.

См. также

CreateDC, GetDC, ReleaseDC .

EnumObjects

Функция EnumObjects перечисляет перья или кисти, доступные для указанного контекста устройства. Эта функция вызывает определяемую приложением функцию обратного вызова один раз для каждого их доступных объектов, предоставляя данные, описывающие объект. EnumObjects продолжает вызывать функцию обратного вызова до тех пор, пока она не вернет нуль или не будут перечислены все доступные объекты.

int EnumObjects (

HDC hdc , // дескриптор контекста устройства

int nObjectType , // идентификатор типа объекта

GOBJENUMPROC lpObjectFunc , // указатель на функцию обратного вызова

LPARAM lParam // указатель на предоставляемые приложением данные

);

Параметры

hdc - идентифицирует контекст устройства.

nObjectType - определяет тип объекта. Может принимать значение OBJ_BRUSH или OBJ_PEN .

lpObjectFunc - указатель на определяемую приложением функцию обратного вызова. Для дополнительной информации об этой функции смотрите описание функции EnumObjectsProc .

lParam - указывает на определяемые приложением данные. Данные передаются в функцию обратного вызова вместе с информацией об объекте.

Возвращаемые значения

Возвращаемое значение определяет последнее значение, возвращенное функцией обратного вызова. Его смысл определяется пользователем. Возвращается -1 в случае наличия слишком большого количества объектов, подлежащих перечислению. В этом случае функция обратного вызова не вызывается.

См. также

EnumObjectsProc, GetObject .

GetDC

Функция GetDC извлекает дескриптор контекста дисплея для клиентской области указанного окна. Контекст дисплея может быть использован в последующих функциях GDI для рисования в клиентской области окна.

Эта функция извлекает общий, классовый или частный контекст устройства в зависимости от стиля класса, указанного для заданного окна. Для общих контекстов устройства GetDC присваивает контексту атрибуты по умолчанию каждый раз при извлечении контекста устройства. Для классовых и частных контекстов устройства GetDC оставляет ранее присвоенные атрибуты без изменений.

HDC GetDC (

HWND hWnd // дескриптор окна

);

Параметры

hWnd - идентифицирует окно, чей контекст устройства извлекается.

Возвращаемые значения

В случае успеха возвращается контекст устройства для клиентской области указанного окна.

В случае неудачи возвращается нуль.

Комментарии

После рисования с общим контекстом устройства должна быть вызвана функция ReleaseDC для освобождения контекста устройства. Классовые и частные контексты устройства не должны освобождаться. Количество контекстов устройства ограничено только объемом доступной памяти.

См. также

ReleaseDC, GetWindowDC .

ResetDC

Функция ResetDC обновляет данный контекст устройства плоттера или принтера, основываясь на информации в указанной структуре.

HDC ResetDC (

HDC hdc , // дескриптор контекста устройства

CONST DEVMODE * lpInitData // адрес структуры с информацией

// о контексте устройства

);

Параметры

hdc - идентифицирует контекст устройства, подлежащий обновлению.

lpInitData - указывает на структуру типа DEVMODE , содержащую информацию о новом контексте устройства.

Возвращаемые значения

В случае успеха возвращается дескриптор оригинального исходного контекста устройства.

В случае неудачи возвращается NULL .

Комментарии

Приложение обычно использует функцию ResetDC при получении сообщения WM _ DEVMODECHANGE. ResetDC также может быть использована для изменения ориентации бумаги или полей бумаги при печати документа. Функция ResetDC не может быть использована для изменения имени драйвера устройства, имени устройства или выходного порта. Когда пользователь изменяет соединение с портом или имя устройства, приложение должно удалить исходный контекст устройства и создать новый контекст с новой информацией.

См. также

DeviceCapabilities, DEVMODE, Escape .

ChooseColor

Функция ChooseColor создает стандартное диалоговое окно выбора цвета.

BOOL ChooseColor (

LPCHOOSECOLOR lpcc // указатель на структуру с инициализирующими данными

);

Параметры

lpcc - указатель на структуру типа CHOOSECOLOR , которая содержит информацию, используемую для инициализации диалогового окна. Когда ChooseColor возвращает управление, структура содержит информацию о выбранном пользователем цвете.

Возвращаемые значения

Если пользователь нажимает кнопку ОК в диалоговом окне, возвращается ненулевое значение. Член rgbResult структуру типа CHOOSECOLOR содержит RGB значение цвета, выбранного пользователем.

Если пользователь нажал кнопку Cancel, или закрыл диалоговое окно, или произошла ошибка - возвращается нуль. Для получения дополнительной информации об ошибке вызовите функцию CommDlgExtendedError , которая может вернуть одно из следующих значений:

CDERR_FINDRESFAILURE

CDERR_MEMLOCKFAILURE

CDERR_INITIALIZATION

CDERR_NOHINSTANCE

CDERR_LOCKRESFAILURE

CDERR_NOHOOK

CDERR_LOADRESFAILURE

CDERR_NOTEMPLATE

CDERR_LOADSTRFAILURE

CDERR_STRUCTSIZE

CDERR_MEMALLOCFAILURE

Комментарии

Стандартное диалоговое окно выбора цвета не поддерживает палитр. Выбор цветов, предлагаемых диалоговым окном, ограничен системными цветами и прореженными (dithered) версиями тех цветов.

Вы можете предоставить функцию-ловушку (hook procedure) CCHookProc для диалогового окна. Функция-ловушка может обрабатывать сообщения, отправляемые диалоговому окну. Для использования функции установите флаг CC_ENABLEHOOK в члене Flags структуры типа CHOOSECOLOR и укажите адрес функции в члене lpfnHook .

См . также

CCHookProc, CHOOSECOLOR, CommDlgExtendedError .

ChooseFont

Функция ChooseFont создает стандартное диалоговое окно выбора шрифта, которое позволяет пользователю выбрать атрибуты для логического шрифта. Эти атрибуты включают в себя имя гарнитуры шрифта, стиль (жирный, наклонный или нормальный), размер, эффекты (подчеркивание, зачеркивание и цвет текста) и написание символов (или набор символов).

BOOL ChooseFont (

LPCHOOSEFONT lpcf // указатель на структуру с инициализирующими данными

);

Параметры

lpcf - указывает на структуру типа CHOOSEFONT , которая содержит информацию, используемую для инициализации диалогового окна. Когда ChooseFont возвращает управление, структура содержит информацию о выбранном пользователем шрифте.

Возвращаемые значения

Если пользователь нажимает кнопку ОК в диалоговом окне, возвращается ненулевое значение. Члены структуры типа CHOOSEFONT показывают выбор пользователя.

Если пользователь нажал кнопку Cancel, или закрыл диалоговое окно, или произошла ошибка - возвращается нуль. Для получения дополнительной информации об ошибке вызовите функцию CommDlgExtendedError , которая может вернуть одно из следующих значений:

CDERR_FINDRESFAILURE

CDERR_NOHINSTANCE

CDERR_INITIALIZATION

CDERR_NOHOOK

CDERR_LOCKRESFAILURE

CDERR_NOTEMPLATE

CDERR_LOADRESFAILURE

CDERR_STRUCTSIZE

CDERR_LOADSTRFAILURE

CFERR_MAXLESSTHANMIN

CDERR_MEMALLOCFAILURE

CFERR_NOFONTS

CDERR_MEMLOCKFAILURE

Комментарии

Вы можете предоставить функцию-ловушку (hook procedure) CCHookProc для диалогового окна. Функция-ловушка может обрабатывать сообщения, отправляемые диалоговому окну. Для использования функции установите флаг CC_ENABLEHOOK в члене Flags структуры типа CHOOSEFONT и укажите адрес функции в члене lpfnHook .

Функция-ловушка может отправлять диалоговому окну сообщения WM _ CHOOSEFONT _ GETLOGFONT, WM _ CHOOSEFONT _ SETFLAGS и WM _ CHOOSEFONT _ SETLOGFONT для получения и установки текущих значений флагов в диалоговом окне.

См. также

CFHookProc, CHOOSEFONT, CommDlgExtendedError, LOGFONT , WM_CHOOSEFONT_GETLOGFONT, WM_CHOOSEFONT_SETFLAGS, WM_CHOOSEFONT_SETLOGFONT.

CopyIcon

Функция CopyIcon копирует заданную иконку в текущий модуль из другого модуля.

HICON CopyIcon (

HICON hIcon // дескриптор копируемой иконки

);

Параметры

hIcon - идентифицирует копируемую иконку.

Возвращаемые значения

В случае успеха возвращается дескриптор на полученную копию иконки.

В случае неудачи возвращается NULL . Для получения дополнительной информации об ошибке вызовите функцию GetLastError .

Комментарии

Функция CopyIcon позволяет приложению или динамически подключаемой библиотеке получить свой собственный дескриптор иконки, находящейся в другом модуле. Если другой модуль прекращает работу, приложение по-прежнему может использовать скопированную иконку.

См . также

CopyCursor, DrawIcon, DrawIconEx.

CreateIcon

Функция CreateIcon создает иконку, которая имеет указанные размер, цвета и битовые шаблоны.

HICON CreateIcon (

HINSTANCE hInstance , // дескриптор экземпляра приложения

int nWidth , // ширина иконки

int nHeight , // высота иконки

BYTE cPlanes , // число плоскостей в битовой маске исключающее ИЛИ

BYTE cBitsPixel , // число бит на пиксель

// в битовой маске исключающее ИЛИ

CONST BYTE * lpbANDbits , // указатель на массив битовой маски И

CONST BYTE * lpbXORbits // указатель на массив битовой маски ИЛИ

);

Параметры

hInstance - идентифицирует экземпляр модуля, создающего иконку.

nWidth - определяет ширину иконки в пикселях.

nHeight - определяет высоту иконки в пикселях.

cPlanes - определяет число плоскостей в битовой маске исключающее ИЛИ иконки.

cBitsPixel - определяет число бит на пиксель в битовой маске исключающее ИЛИ иконки.

lpbANDbits - указатель на массив байт, который содержит битовые значения для маски И иконки. Такая битовая маска описывает монохромное изображение.

lpbXORbits - указатель на массив байт, который содержит битовые значения для маски исключающее ИЛИ иконки. Такая битовая маска описывает зависимое от устройства цветное изображение.

Возвращаемые значения

В случае успеха возвращается дескриптор иконки.

В случае неудачи возвращается нуль. Для получения дополнительной информации об ошибке вызовите функцию GetLastError .

Комментарии

Значения параметров nWidth и nHeight должны указывать ширину и высоту, поддерживаемые текущим драйвером дисплея, потому что система не может создать иконки других размеров. Для определения того, какие ширина и высота поддерживаются драйвером дисплея, вызовите функцию GetSystemMetrics , указав значения SM _ CXICON и SM _ CYICON .

CreateIcon применяет следующую таблицу истинности для битовых масок.

См. также

GetSystemMetrics .

CreateIconFromResource

Функция CreateIconFromResource создает иконку или курсор из битов ресурса, описывающих иконку.

HICON CreateIconFromResource (

PBYTE presbits , // указатель на биты ресурса

DWORD dwResSize , // число бит в буфере

BOOL fIcon , // флаг иконки или курсора

DWORD dwVer // версия формата Windows

);

Параметры

presbits - указывает на буфер, содержащий биты ресурса иконки или курсора. Эти биты обычно загружаются вызовами функций LookupIconIdFromDirectory (в Windows 95 вы также можете использовать функцию LookupIconIdFromDirectoryEx ) и LoadResource .

dwResSize - определяет размер, в байтах, набора битов, на который указывает параметр presbits .

fIcon - определяет, будет ли создаваться иконка или курсор. Если значение этого параметра равно TRUE, создается иконка. Иначе создается курсор.

dwVer - определяет номер версии формата иконки или курсора для битов ресурса, на которые указывает параметр presbits . Параметр может принимать одно из следующих значений:

Все Win 32 приложения должны использовать для иконок и курсоров формат Windows 3. x .

Возвращаемые значения

В случае успеха возвращается дескриптор иконки или курсора.

В случае неудачи возвращается нуль. Для получения дополнительной информации об ошибке вызовите функцию GetLastError .

Комментарии

Функции CreateIconFromResource, CreateIconIndirect, GetIconInfo и LookupIconIdFromDirectory (в Windows 95 также функции CreateIconFromResourceEx и LookupIconIdFromDirectoryEx ) позволяют приложениям оболочки и браузерам иконок проверять и использовать ресурсы всей системы.

См. также

CreateIconFromResourceEx, CreateIconIndirect, GetIconInfo, LoadResource, LookupIconIdFromDirectory, LookupIconIdFromDirectoryEx .

CreateIconFromResourceEx

Функция CreateIconFromResourceEx создает иконку или курсор из битов ресурса, описывающих иконку.

HICON CreateIconFromResourceEx (

PBYTE pbIconBits , // указатель на биты ресурса

DWORD cbIconBits , // число бит в буфере

BOOL fIcon , // флаг иконки или курсора

DWORD dwVersion , // версия формата Windows

int cxDesired , // желаемая ширина иконки или курсора

int cyDesired , // желаемая высота иконки или курсора

UINT uFlags

);

Параметры

pbIconBits - указывает на буфер, содержащий биты ресурса иконки или курсора. Эти биты обычно загружаются вызовами функций LookupIconIdFromDirectory (в Windows 95 вы также можете использовать функцию LookupIconIdFromDirectoryEx ) и LoadResource .

cbIconBits - определяет размер, в байтах, набора битов, на который указывает параметр pbIconBits .

fIcon - определяет, будет ли создаваться иконка или курсор. Если значение этого параметра равно TRUE, создается иконка. Иначе создается курсор.

dwVersion - определяет номер версии формата иконки или курсора для битов ресурса, на которые указывает параметр pbIconBits . Параметр может принимать одно из следующих значений:

Все Win 32 приложения должны использовать для иконок и курсоров формат Windows 3. x .

cxDesired - определяет желаемую ширину иконки или курсора в пикселях. Если значение этого параметра равно нулю, функция использует значения метрики системы SM _ CXICON или SM _ CXCURSOR для установки ширины.

cyDesired - определяет желаемую высоту иконки или курсора в пикселях. Если значение этого параметра равно нулю, функция использует значения метрики системы SM _ CXICON или SM _ CXCURSOR для установки высоты.

uFlags - определяет комбинацию из следующих значений:

Возвращаемые значения

В случае успеха возвращается дескриптор иконки или курсора.

В случае неудачи возвращается нуль. Для получения дополнительной информации об ошибке вызовите функцию GetLastError .

Комментарии

Функции CreateIconFromResourceEx, CreateIconFromResource , CreateIconIndirect, GetIconInfo и LookupIconIdFromDirectoryEx позволяют приложениям оболочки и браузерам иконок проверять и использовать ресурсы всей системы.

См. также

BITMAPINFOHEADER, CreateIconFromResource, CreateIconIndirect, GetIconInfo, LoadResource, LookupIconIdFromDirectoryEx .

CreateIconIndirect

Функция CreateIconIndirect создает иконку или курсор по информации из структуры типа ICONINFO .

HICON CreateIconIndirect (

PICONINFO piconinfo // указатель на структуру с

// информацией об иконке

);

Параметры

piconinfo - указывает на структуру типа ICONINFO , которую функция использует для создания иконки или курсора.

Возвращаемые значения

В случае успеха возвращается дескриптор созданной иконки или курсора.

В случае неудачи возвращается NULL . Для получения дополнительной информации об ошибке вызовите функцию GetLastError .

Комментарии

Система копирует битовые образы в структуру типа ICONINFO перед созданием иконки или курсора. Приложение должно продолжать управлять исходными битовыми образами и удалить их при отсутствии в них дальнейшей необходимости.

Когда вы закончили использовать иконку, вызовите функцию DestroyIcon .

См . также

DestroyIcon, ICONINFO .

GetIconInfo

Функция GetIconInfo извлекает информацию об указанной иконке или курсоре.

BOOL GetIconInfo (

HICON hIcon , дескриптор иконки

PICONINFO piconinfo // адрес структуры иконки

);

Параметры

hIcon - идентифицирует иконку или курсор. Для извлечения информации о стандартной иконке или курсоре, укажите одно из следующих значений:

piconinfo - указывает на структуру типа ICONINFO . Функция заполняет члены структуры.

Возвращаемые значения

В случае успеха возвращается ненулевое значение, и функция заполняет члены структуры типа ICONINFO .

В случае неудачи возвращается нуль. Для получения дополнительной информации об ошибке вызовите функцию GetLastError .

Комментарии

GetIconInfo создает битовые изображения для членов hbmMask и hbmColor структуры типа ICONINFO . Вызывающее приложение должно управлять этими изображениями и удалять их, когда в них отпадает необходимость.

См. также

CreateIcon, CreateIconFromResource, CreateIconIndirect, DestroyIcon, DrawIcon, DrawIconEx, ICONINFO, LoadIcon, LookupIconIdFromDirectory .

ClientToScreen

Функция ClientToScreen преобразует клиентские координаты указанной точки в экранные координаты.

BOOL ClientToScreen (

HWND hWnd , // дескриптор окна для исходных координат

LPPOINT lpPoint // указатель на структуру, содержащую

// экранные координаты

);

Параметры

hWnd - идентифицирует окно, чья клиентская область используется для преобразования.

lpPoint - указывает на структуру типа POINT , которая содержит преобразуемые координаты. В случае успеха в эту структуру копируются новые экранные координаты.

Возвращаемые значения

В случае успеха возвращается ненулевое значение.

В случае неудачи возвращается нуль.

Комментарии

Функция ClientToScreen замещает клиентские координаты в структуре типа POINT экранными координатами. Экранные координаты относительны верхнего левого угла экрана.

См. также

MapWindowPoints, POINT, ScreenToClient .

CombineTransform

Функция CombineTransform объединяет два преобразования " мировое пространство - пространство страницы " (world-space to page-space transformations).

BOOL CombineTransform (

LPXFORM lpxformResult , // указатель на комбинированное преобразование

CONST XFORM * lpxform 1 , // указатель на первое преобразование

CONST XFORM * lpxform 2 // указатель на второе преобразование

);

Параметры

lpxformResult - указывает на структуру типа XFORM , которая получает комбинированное преобразование.

lpxform 1 - указывает на структуру типа XFORM , которая идентифицирует первое преобразование.

lpxform 2 - указывает на структуру типа XFORM , которая идентифицирует второе преобразование.

Возвращаемые значения

В случае успеха возвращается ненулевое значение.

В случае неудачи возвращается нуль.

Комментарии

Применение комбинированного преобразования аналогично применению сначала первого преобразования, затем второго.

Три преобразования не обязательно должны быть раздельными. Например, lpxform 1 может указывать на ту же структуру типа XFORM , что и lpxformResult .

См. также

GetWorldTransform, ModifyWorldTransform, SetWorldTransform, XFORM .

GetGraphicsMode

Функция GetGraphicsMode извлекает текущий графический режим для указанного контекста устройства.

int GetGraphicsMode (

HDC hdc // дескриптор контекста устройства

);

Параметры

hdc - идентифицирует контекст устройства.

Возвращаемые значения

В случае успеха возвращается текущий графический режим. Он может быть представлен одним из следующих значений:

В противном случае, возвращается нуль.

Комментарии

Приложение может установить графический режим для контекста устройства, вызвав функцию SetGraphicsMode .

См. также

SetGraphicsMode .

ChangeClipboardChain

Функция ChangeClipboardChain удаляет указанное окно из цепочки просмотра буфера обмена.

BOOL ChangeClipboardChain (

HWND hWndRemove ,

HWND hWndNewNext

);

Параметры

hWndRemove - дескриптор окна, которое будет удалено из цепочки. Дескриптор должен был быть передан в функцию SetClipboardViewer.

hWndNewNext - дескриптор окна, которое следует за окном, определяемым значением параметра hWndRemove, в цепочке просмотра буфера обмена. (Это дескриптор, возвращенный функцией SetClipboardViewer , если только последовательность не была изменена в ответ на сообщение WM_CHANGECBCHAIN .)

Возвращаемые значения

Возвращаемое значение показывает результат передачи сообщения WM_CHANGECBCHAIN окну в цепочке просмотра буфера обмена. Поскольку окно в цепочке типично возвращает FALSE, когда оно обрабатывает сообщение WM_CHANGECBCHAIN, типично возвращаемое функцией ChangeClipboardChain значение - тоже FALSE. Если в цепочке просмотра одно окно - типично возвращается TRUE.

Комментарии

Окно, идентифицируемое значением параметра hWndNewNext, заменяет окно, идентифицируемое значением параметра hWndRemove , в цепочке просмотра. Функция SetClipboardViewer отправляет сообщение WM_CHANGECBCHAIN первому окну в цепочке просмотра буфера обмена.

Требования

Windows NT/2000/XP: Включена в Windows NT 3.1 и выше.

Windows 95/98/Me: Включена в Windows 95 и выше.

Заголовок: Объявлена в Winuser.h ; подключатьWindows.h.

Библиотека: Используйте User32.lib .

См . также

SetClipboardViewer, WM_CHANGECBCHAIN.

CloseClipboard

Функция CloseClipboard закрывает буфер обмена.

BOOL CloseClipboard (VOID)

Параметры

Функция не имеет параметров.

Возвращаемые значения

В случае успеха возвращается ненулевое значение.

В случае неудачи возвращается нуль. Для получения дополнительной информации об ошибке вызовите функцию GetLastError .

Комментарии

Когда окно закончило проверку или изменение содержимого буфера обмена, закройте его, вызвав CloseClipboard . Это позволит другим окнам получить доступ к буферу обмена.

Не помещайте объект в буфер обмена после вызова CloseClipboard .

См. также

GetOpenClipboardWindow, OpenClipboard .

CountClipboardFormats

Функция CountClipboardFormats извлекает число различных форматов данных в буфере обмена в настоящий момент

int CountClipboardFormats ( VOID )

Параметры

Функция не имеет параметров.

Возвращаемые значения

В случае успеха возвращается количество различных форматов данных в буфере обмена в настоящий момент.

В случае неудачи возвращается нуль. Для получения дополнительной информации об ошибке вызовите функцию GetLastError .

См. также

EnumClipboardFormats, RegisterClipboardFormat .

GetClipboardFormatName

Функция GetClipboardFormatName извлекает из буфера обмена имя указанного зарегистрированного формата. Функция копирует имя в указанный буфер.

int GetClipboardFormatName (

UINT format , // извлекаемый формат буфера обмена

LPTSTR lpszFormatName , // адрес буфера для имени

int cchMaxCount // длина строки имени в символах

);

Параметры

format - определяет тип извлекаемого формата. Значение этого параметра не должно указывать на один из ранее предопределенных форматов.

lpszFormatName - указывает на буфер, который получает имя формата.

cchMaxCount - определяет максимальную длину строки, скопированной в буфер, в символах. Если имя превышает этот предел, лишние символы строки отбрасываются.

Возвращаемые значения

В случае успеха возвращается длина скопированной в буфер строки в символах.

В случае неудачи возвращается нуль, указывая, что затребованный формат не существует или является ранее предопределенным форматом. Для получения дополнительной информации об ошибке вызовите функцию GetLastError .

См. также

EnumClipboardFormats, RegisterClipboardFormat .

GetClipboardOwner

Функция GetClipboardOwner извлекает дескриптор окна, являющегося текущим владельцем буфера обмена.

HWND GetClipboardOwner ( VOID )

Параметры

Функция не имеет параметров.

Возвращаемые значения

В случае успеха возвращается дескриптор окна, которое владеет буфером обмена.

В случае неудачи возвращается NULL . Для получения дополнительной информации об ошибке вызовите функцию GetLastError .

Комментарии

Буфер обмена может содержать данные, даже если им в настоящий момент никто не владеет.

В общем, владельцем буфера обмена является окно, которое последним поместило данные в него. Функция EmptyClipboard назначает владение буфером обмена.

См. также

EmptyClipboard, GetClipboardViewer .

CompareFileTime

Функция CompareFileTime сравнивает два 64-битных файловых времени.

LONG CompareFileTime (

CONST FILETIME * lpFileTime1 , // pointer to first file time

CONST FILETIME * lpFileTime2 // pointer to second file time

);

Параметры

lpFileTime 1 - указывает на структуру типа FILETIME , которая определяет первое 64-битное файловое время.

lpFileTime 2 - указывает на структуру типа FILETIME , которая определяет второе 64-битное файловое время.

Возвращаемые значения

В случае успеха возвращается одно из следующих значений:

См. также

GetFileTime, FILETIME .

GetFileTime

Функция GetFileTime извлекает дату и время файла, когда он был создан, когда к нему последний раз обращались, и когда он последний раз был изменен.

BOOL GetFileTime (

HANDLE hFile , // идентифицирует файл

LPFILETIME lpCreationTime , // адрес времени создания файла

LPFILETIME lpLastAccessTime , // адрес времени последнего доступа

// к файлу

LPFILETIME lpLastWriteTime // адрес времени последней записи в файл

);

Параметры

hFile - идентифицирует файл, для которого извлекаются дата и время. Файловый дескриптор должен быть создан с доступом GENERIC_READ к файлу.

lpCreationTime - указывает на структуру типа FILETIME , которая получает дату и время создания файла. Значение этого параметра может быть равно NULL, если приложению не требуется эта информация.

lpLastAccessTime - указывает на структуру типа FILETIME , которая получает дату и время последнего доступа к файлу. Время последнего доступа включает в себя время, когда в последний раз: в файл записывалась информация, читалась информация из файла, или, в случае исполняемых файлов, файл запускался на исполнение. Значение этого параметра может быть равно NULL, если приложению не требуется эта информация.

lpLastWriteTime - указывает на структуру типа FILETIME , которая получает дату и время последней записи в файл. Значение этого параметра может быть равно NULL, если приложению не требуется эта информация.

Возвращаемые значения

В случае успеха возвращается ненулевое значение.

В случае неудачи возвращается нуль. Для получения дополнительной информации об ошибке вызовите функцию GetLastError .

Комментарии

Файловые системы FAT и NTFS поддерживают время создания файла, время последнего доступа к файлу и время последней записи в файл.

Windows 95: Точность значения времени для файла в файловой системе FAT - 2 секунды. Точность значения времени для файлов в других файловых системах, например, на сетевых дисках, зависит от файловой системы, но также может быть ограничена удаленным устройством.

См. также

FILETIME, GetFileSize, GetFileType, SetFileTime .

CopyRect

Функция CopyRect копирует координаты одного прямоугольника в другой.

BOOL CopyRect (

LPRECT lprcDst , // указатель на структуру для прямоугольника

// назначения

CONST RECT * lprcSrc // указатель на структуру для исходного

// прямоугольника

);

Параметры

lprcDst - указывает на структуру RECT , которая получает логические координаты исходного прямоугольника.

lprcSrc - указывает на структуру RECT , чьи координаты копируются.

Возвращаемые значения

В случае успеха возвращается ненулевое значение.

В случае неудачи возвращается нуль. Для получения дополнительной информации об ошибке вызовите функцию GetLastError .

См. также

RECT, SetRect, SetRectEmpty .

CreateDialog

Макрос CreateDialog создает немодальное диалоговое окно из ресурса - шаблона диалогового окна. Макрос CreateDialog использует функцию CreateDialogParam .

HWND CreateDialog (

HINSTANCE hInstance , // дескриптор экземпляра приложения

LPCTSTR lpTemplate , // идентифицирует имя шаблона диалогового окна

HWND hWndParent , // дескриптор окна - владельца

DLGPROC lpDialogFunc // указатель на оконную процедуру

// диалогового окна

);

Параметры

hInstance - идентифицирует экземпляр модуля, чей исполняемый файл содержит шаблон диалогового окна.

lpTemplate - идентифицирует шаблон диалогового окна. Этот параметр является либо указателем на завершающуюся нулем строку, определяющей имя шаблона диалогового окна, либо целым значением, которое определяет идентификатор ресурса шаблона диалогового окна. Если этот параметр является идентификатором ресурса, его старшее слово должно быть равно нулю, а младшее слово должно содержать идентификатор. Вы можете использовать макрос MAKEINTRESOURCE для создания этого значения.

hWndParent - идентифицирует окно, владеющее диалоговым окном.

lpDialogFunc - указатель на оконную процедуру диалогового окна. Для дополнительной информации об этой процедуре смотрите DialogProc .

Возвращаемые значения

В случае успеха возвращается дескриптор диалогового окна.

В случае неудачи возвращается NULL .

Комментарии

Функция CreateDialog использует функцию CreateWindowEx для создания диалогового окна. Затем CreateDialog отправляет сообщение WM _ INITDIALOG (а также сообщение WM _ SETFONT, если шаблон задает стиль DS _ SETFONT ) оконной процедуре диалогового окна. Функция отображает диалоговое окно, в случае если шаблон задает стиль WS _ VISIBLE. В заключение, CreateDialog возвращает дескриптор диалогового окна.

После того, как функция CreateDialog вернет управление, приложение отображает диалоговое окно (если оно еще не отображено), используя функцию ShowWindow . Приложение разрушает диалоговое окно, используя функцию DestroyWindow .

Windows 95: Система поддерживает максимум 16384 дескрипторов окон.

См. также

CreateDialogIndirect, CreateDialogIndirectParam, CreateDialogParam, CreateWindowEx, DestroyWindow, DialogBox, DialogProc, ShowWindow , WM_INITDIALOG, WM_SETFONT.

CreateDialogIndirect

Макрос CreateDialogIndirect создает в памяти немодальное диалоговое окно из ресурса - шаблона диалогового окна. Макрос CreateDialogIndirect использует функцию CreateDialogIndirectParam .

HWND CreateDialogIndirect (

HINSTANCE hInstance , // дескриптор экземпляра приложения

LPCDLGTEMPLATE lpTemplate , // указатель на шаблон диалогового окна

HWND hWndParent , // дескриптор окна-владельца

DLGPROC lpDialogFunc // указатель на оконную процедуру

// диалогового окна

);

Параметры

hInstance - идентифицирует экземпляр модуля, который создает диалоговое окно.

lpTemplate - указатель на глобальный объект памяти, содержащий шаблон, который CreateDialogIndirect использует для создания диалогового окна. Шаблон диалогового окна состоит из заголовка, который описывает диалоговое окно, за которым следует один или более дополнительных блоков данных, которые описывают каждый из элементов управления диалогового окна. Шаблон может использовать стандартный или расширенный формат.

В стандартном шаблоне заголовок представляет собой структуру DLGTEMPLATE , за которой следуют массивы переменной длины. Данные для каждого из элементов управления состоят из структуры DLGITEMTEMPLATE , за которой следуют массивы переменной длины.

В расширенном шаблоне диалогового окна заголовок использует формат DLGTEMPLATEEX и определения элементов управления используют формат DLGITEMTEMPLATEEX .

hWndParent - идентифицирует окно, владеющее диалоговым окном.

lpDialogFunc - указатель на оконную процедуру диалогового окна. Для дополнительной информации об этой процедуре смотрите DialogProc .

Возвращаемые значения

В случае успеха возвращается дескриптор диалогового окна.

В случае неудачи возвращается NULL .

Комментарии

Макрос CreateDialogIndirect использует функцию CreateWindowEx для создания диалогового окна. Затем CreateDialogIndirect отправляет сообщение WM _ INITDIALOG оконной процедуре диалогового окна. Если шаблон задает стиль DS _ SETFONT, функция также отправляет сообщение WM _ SETFONT оконной процедуре диалогового окна. Функция отображает диалоговое окно, в случае если шаблон задает стиль WS _ VISIBLE. В заключение, CreateDialogIndirect возвращает дескриптор диалогового окна.

После того, как функция CreateDialogIndirect вернет управление, приложение отображает диалоговое окно (если оно еще не отображено), используя функцию ShowWindow . Приложение разрушает диалоговое окно, используя функцию DestroyWindow .

В стандартном шаблоне диалогового окна структура DLGTEMPLATE и каждая из структур DLGITEMTEMPLATE должны быть выровнены по DWORD . Массив данных, находящийся после структуры DLGITEMTEMPLATE , также должен быть выровнен по DWORD . Все остальные массивы переменной длины в шаблоне должны быть выровнены по WORD .

В расширенном шаблоне диалогового окна заголовок DLGTEMPLATEEX и каждое из определений элементов управления DLGITEMTEMPLATEEX должны быть выровнены по DWORD . Массив данных, находящийся после структуры DLGITEMTEMPLATE , также должен быть выровнен по DWORD . Все остальные массивы переменной длины в шаблоне должны быть выровнены по WORD .

Все строки символов в шаблоне диалогового окна, такие как заголовки для диалогового окна и кнопок, должны быть строками UnicodE. Для написания кода, который работает как в Windows NT, так и в Windows 95, используйте функцию MultiByteToWideChar для создания строк UnicodE.

Windows 95: Система поддерживает максимум 16384 дескрипторов окон.

См. также

CreateDialog, CreateDialogIndirectParam, CreateDialogParam, CreateWindowEx, DestroyWindow, DialogProc, DLGITEMTEMPLATE, DLGITEMTEMPLATEEX, DLGTEMPLATE, DLGTEMPLATEEX, MultiByteToWideChar, ShowWindow , WM_INITDIALOG, WM_SETFONT.

CreateDialogIndirectParam

Функция CreateDialogIndirectParam создает в памяти немодальное диалоговое окно из ресурса - шаблона диалогового окна. Перед отображением диалогового окна функция передает определяемое приложением значение в оконную процедуру диалогового окна в качестве параметра lParam сообщения WM _ INITDIALOG . Приложение может использовать это значение для инициализации элементов управления диалогового окна.

HWND CreateDialogIndirectParam (

HINSTANCE hInstance , // дескриптор экземпляра приложения

LPCDLGTEMPLATE lpTemplate , // указатель на шаблон диалогового окна

HWND hWndParent , // дескриптор окна-владельца

DLGPROC lpDialogFunc , // указатель на оконную процедуру

LPARAM lParamInit // инициализирующее значение

);

Параметры

hInstance - идентифицирует экземпляр модуля, который создает диалоговое окно.

lpTemplate - указатель на глобальный объект памяти, содержащий шаблон, который CreateDialogIndirectParam использует для создания диалогового окна. Шаблон диалогового окна состоит из заголовка, который описывает диалоговое окно, за которым следует один или более дополнительных блоков данных, которые описывают каждый из элементов управления диалогового окна. Шаблон может использовать стандартный или расширенный формат.

В стандартном шаблоне заголовок представляет собой структуру DLGTEMPLATE , за которой следуют массивы переменной длины. Данные для каждого из элементов управления состоят из структуры DLGITEMTEMPLATE , за которой следуют массивы переменной длины.

В расширенном шаблоне диалогового окна заголовок использует формат DLGTEMPLATEEX и определения элементов управления используют формат DLGITEMTEMPLATEEX .

hWndParent - идентифицирует окно, владеющее диалоговым окном.

lpDialogFunc - указатель на оконную процедуру диалогового окна. Для дополнительной информации об этой процедуре смотрите DialogProc .

lParamInit - определяет значение, передаваемое в оконную процедуру диалогового окна как параметр lParam сообщения WM _ INITDIALOG .

Возвращаемые значения

В случае успеха возвращается дескриптор диалогового окна.

В случае неудачи возвращается NULL .

Комментарии

Функция CreateDialogIndirectParam использует функцию CreateWindowEx для создания диалогового окна. Затем CreateDialogIndirectParam отправляет сообщение WM _ INITDIALOG оконной процедуре диалогового окна. Если шаблон задает стиль DS _ SETFONT, функция также отправляет сообщение WM _ SETFONT оконной процедуре диалогового окна. Функция отображает диалоговое окно, в случае если шаблон задает стиль WS _ VISIBLE. В заключение, CreateDialogIndirectParam возвращает дескриптор диалогового окна.

После того, как функция CreateDialogIndirectParam вернет управление, приложение отображает диалоговое окно (если оно еще не отображено), используя функцию ShowWindow . Приложение разрушает диалоговое окно, используя функцию DestroyWindow .

В стандартном шаблоне диалогового окна структура DLGTEMPLATE и каждая из структур DLGITEMTEMPLATE должны быть выровнены по DWORD . Массив данных, находящийся после структуры DLGITEMTEMPLATE , также должен быть выровнен по DWORD . Все остальные массивы переменной длины в шаблоне должны быть выровнены по WORD .

В расширенном шаблоне диалогового окна заголовок DLGTEMPLATEEX и каждое из определений элементов управления DLGITEMTEMPLATEEX должны быть выровнены по DWORD . Массив данных, находящийся после структуры DLGITEMTEMPLATE , также должен быть выровнен по DWORD . Все остальные массивы переменной длины в шаблоне должны быть выровнены по WORD .

Все строки символов в шаблоне диалогового окна, такие как заголовки для диалогового окна и кнопок, должны быть строками UnicodE. Для написания кода, который работает как в Windows NT, так и в Windows 95, используйте функцию MultiByteToWideChar для создания строк UnicodE.

Windows 95: Система поддерживает максимум 16384 дескрипторов окон.

См. также

CreateDialog, CreateDialogIndirect, CreateDialogParam, CreateWindowEx, DestroyWindow, DialogProc, DLGITEMTEMPLATE, DLGITEMTEMPLATEEX, DLGTEMPLATE, DLGTEMPLATEEX, MultiByteToWideChar, ShowWindow , WM_INITDIALOG, WM_SETFONT.

DefDlgProc

Функция DefDlgProc выполняет обработку сообщений по умолчанию для оконной процедуры, принадлежащей определяемому приложением классу диалогового окна.

LRESULT DefDlgProc (

HWND hDlg , // дескриптор диалогового окна

UINT Msg , // сообщение

WPARAM wParam , // первый параметр сообщения

LPARAM lParam // второй параметр сообщения

);

Параметры

hDlg - идентифицирует диалоговое окно.

uMsg - определяет сообщение.

wParam - определяет дополнительную информацию, зависящую от сообщения.

lParam - определяет дополнительную информацию, зависящую от сообщения.

Возвращаемые значения

Возвращаемое значение определяет результат обработки сообщения и зависит от переданного сообщения.

Комментарии

Функция DefDlgProc является оконной процедурой для предопределенного класса диалогового окна. Эта процедура обеспечивает внутреннюю обработку для диалогового окна, перенаправляя сообщения оконной процедуре диалогового окна и производя обработку по умолчанию для сообщения, при обработке которого оконная процедура возвращает FALSE. Приложения, которые создают диалоговые окна на основе своих собственных классов диалоговых окон, часто используют DefDlgProc вместо DefWindowProc для обработки сообщений по умолчанию.

Приложения создают собственные классы диалоговых окон, заполняя структуру типа WNDCLASS соответствующей информацией и регистрируя класс с помощью функции RegisterClass . Некоторые приложения заполняют структуру, используя функцию GetClassInfo , указывая имя предопределенного диалогового окна. В таких случаях, приложения модифицируют, по меньшей мере, член lpszClassName перед регистрацией. И во всех случаях, член cbWndExtra структуры типа WNDCLASS для создаваемых приложением классов диалоговых окон, должен быть установлен, по меньшей мере в DLGWINDOWEXTRA .

Функция DefDlgProc не должна вызываться оконной процедурой диалогового окна - это приведет к рекурсивным вызовам этих двух функций.

См. также

DefWindowProc, GetClassInfo, RegisterClass, WNDCLASS .

GetDialogBaseUnits

Функция GetDialogBaseUnits возвращает базовые координаты диалогового окна, используемые Windows для создания диалоговых окон. И Windows, и приложения используют эти координаты для преобразования ширины и высоты диалоговых окон и находящихся в них элементов управления из оконных координат, указанных в шаблонах диалоговых окон, в пиксели, и обратно.

LONG GetDialogBaseUnits ( VOID )

Параметры

Функция не имеет параметров.

Возвращаемые значения

Возвращается 32-битное значение, содержащее базовые координаты диалогового окна. Младшее слово возвращаемого значения содержит горизонтальные базовые координаты диалогового окна, старшее слово - вертикальные.

Комментарии

Горизонтальные базовые координаты диалогового окна равны средней ширине, в пикселях, символов системного шрифта, вертикальные - средней высоте символов системного шрифта. К тому же, горизонтальная базовая координата равна четырем горизонтальным оконным координатам диалогового окна, вертикальная базовая координата - восьми вертикальным оконным координатам диалогового окна. Таким образом, преобразование оконных координат в пиксели происходит по формулам:

пиксель X = (диалоговая_координата X * базовая_координата X ) / 4

пиксель Y = (диалоговая_координата Y * базовая_координата Y ) / 8

Аналогично происходит преобразование пикселей в оконные координаты:

диалоговая_координата X = (пиксель X * 4) / базовая_координата X

диалоговая_координата Y = (пиксель Y * 8) / базовая_координата Y

См. также

MapDialogRect .

GetDlgCtrlID

Функция GetDlgCtrlID возвращает идентификатор заданного элемента управления.

int GetDlgCtrlID (

HWND hwndCtl // дескриптор элемента управления

);

Параметры

hwndCtl - идентифицирует элемент управления.

Возвращаемые значения

В случае успеха возвращается идентификатор элемента управления.

В случае неудачи возвращается NULL . Вызов функции также закончится неудачей при неверном значении параметра hwndCtl .

Комментарии

GetDlgCtrlID также принимает в качестве параметров и дескрипторы дочерних окон, наравне с дескрипторами элементов управления в диалоговых окнах. Приложение устанавливает идентификатор для дочернего окна, присваивая значение идентификатора параметру hMenu при вызове функций CreateWindow или CreateWindowEx .

Хотя функция GetDlgCtrlID может вернуть значение в случае, если параметр hwndCtl идентифицирует окно верхнего уровня, такие окна не могут иметь идентификаторов и, соответственно, не будет возвращено правильного значения.

См . также

CreateWindow, CreateWindowEx, GetDlgItem .

CreateMailslot

Функция CreateMailslot создает мэйлслот с указанным именем и возвращает дескриптор, который мэйлслотовый сервер может использовать для выполнения операций над мэйлслотом. Мэйлслот локален относительно компьютера, который его создал. Если мэйлслот с указанным именем существует, то происходит ошибка.

HANDLE CreateMailslot (

LPCTSTR lpName , // указатель на строку с именем мэйлслота

DWORD nMaxMessageSize , // максимальный размер сообщения

DWORD lReadTimeout , // миллисекунды до тайм - аута чтения

LPSECURITY_ATTRIBUTES lpSecurityAttributes // указатель

// на структуру безопасности

);

Параметры

lpName - указывает на завершающуюся нулем строку, определяющую имя мэйлслота. Строка должна иметь следующий вид:

\\.\mailslot\[path]name

Поле name должно быть уникальным. Имя может включать множественные уровни псевдодиректорий, разделенных символами обратного слэша. Например, правильными именами являются \\.\ mailslot \ example_mailslot_name и \\.\mailslot\abc\def\ghi .

nMaxMessageSize - определяет максимальный размер сообщения в байтах, которое может быть записано в мэйлслот. Для указания того, что сообщение может быть любого размера, установите значение этого параметра в нуль.

lReadTimeout - определяет количество времени, в миллисекундах, которое операция чтения может ждать сообщения, записанного в мэйлслот, до наступления тайм-аута. Следующие величины имеют специальные значения:

0 - функция возвращает управление немедленно, если в мэйлслоте отсутствует сообщение. (Система не трактует немедленное возвращение как ошибку.)

MAILSLOT_WAIT_FOREVER - ждет до тех пор, пока не придет сообщение.

Величина тайм-аута применяется ко всем последующим операциям чтения и всем унаследованным дескрипторам мэйлслота.

lpSecurityAttributes - указывает на структуру типа SECURITY_ATTRIBUTES , которая определяет, может ли возвращаемый дескриптор мэйлслота наследоваться дочерними процессами. Если значение lpSecurityAttributes равно NULL, дескриптор не может быть унаследован.

Windows NT : Член lpSecurityDescriptor структуры определяет дескриптор безопасности для нового мэйлслота. Если значение lpSecurityDescriptor равно NULL, мэйлслот получает дескриптор безопасности по умолчанию.

Windows 95: Член lpSecurityDescriptor структуры игнорируется.

Возвращаемые значения

В случае успеха возвращается дескриптор мэйлслота.

В случае неудачи возвращается INVALID_HANDLE_VALUE. Для получения дополнительной информации об ошибке вызовите функцию GetLastError .

Комментарии

Мэйлслот существует до тех пор, пока:

Последний (возможно, унаследованный или дублированный) дескриптор не закрыт функцией CloseHandle .

Процесс, владеющий последним (возможно, унаследованным или дублированным) дескриптором, существует.

И Windows NT, и Windows 95 используют второй метод для разрушения мэйлслотов.

Для записи сообщения в мэйлслот процесс использует функцию CreateFile , указав имя мэйлслота в одном из следующих форматов:

Если CreateFile определяет домен или использует звездочку для указания первичного домена системы, приложение не может записать в мэйлслот более 400 символов за раз. Если приложение попытается сделать это, вызов WriteFile завершится неудачей и GetLastError вернет ERROR_BAD_NETPATH .

Приложение должно указать флаг FILE_SHARE_READ при использовании CreateFile для получения клиентского дескриптора мэйлслота.

См. также

CloseHandle, CreateFile, GetMailslotInfo, SECURITY_ATTRIBUTES, SetMailslotInfo, WriteFile .

GetMailslotInfo

Функция GetMailslotInfo извлекает информацию об указанном мэйлслоте.

BOOL GetMailslotInfo (

HANDLE hMailslot , // дескриптор мэйлслота

LPDWORD lpMaxMessageSize , // адрес максимального размера сообщения

LPDWORD lpNextSize , // адрес размера следующего сообщения

LPDWORD lpMessageCount , // адрес количества сообщений

LPDWORD lpReadTimeout // адрес тайм - аута чтения

);

Параметры

hMailslot - идентифицирует мэйлслот. Этот дескриптор должна создать функция CreateMailslot .

lpMaxMessageSize - когда функция возвращает управление, указывает на буфер, определяющий максимальный размер письма в байтах, допустимый для этого мэйлслота. Эта величина должна быть больше или равна значению параметра cbMaxMsg функции CreateMailslot , создавшей мэйлслот. Значение параметра может быть равно нулю.

lpNextSize - когда функция возвращает управление, указывает на буфер, определяющий размер следующего письма в байтах. Следующая величина имеет специальное значение:

MAILSLOT_NO_MESSAGE - следующее сообщение отсутствует.

Значение параметра может быть равно нулю.

lpMessageCount - когда функция возвращает управление, указывает на буфер, определяющий количество сообщений, ждущих прочтения. Значение параметра может быть равно нулю.

lReadTimeout - указывает на буфер, определяющий количество времени, в миллисекундах, которое операция чтения может ждать сообщения, записанного в мэйлслот, до наступления тайм-аута. Параметр заполняется, когда функция возвращает управление. Значение параметра может быть равно нулю.

Возвращаемые значения

В случае успеха возвращается ненулевое значение.

В случае неудачи возвращается нуль. Для получения дополнительной информации об ошибке вызовите функцию GetLastError .

См. также

CreateMailslot, SetMailslotInfo .

SetMailslotInfo

Функция SetMailslotInfo устанавливает величину тайм-аута, используемую указанным мэйлслотом для операции чтения.

BOOL SetMailslotInfo (

HANDLE hMailslot , // дескриптор мэйлслота

DWORD lReadTimeout // тайм - аут чтения

);

Параметры

hMailslot - идентифицирует мэйлслот. Этот дескриптор должна создать функция CreateMailslot .

lReadTimeout - определяет количество времени, в миллисекундах, которое операция чтения может ждать сообщения, записанного в мэйлслот, до наступления тайм-аута. Следующие величины имеют специальные значения:

0 - функция возвращает управление немедленно, если в мэйлслоте отсутствует сообщение. (Система не трактует немедленное возвращение как ошибку.)

MAILSLOT_WAIT_FOREVER - ждет до тех пор, пока не придет сообщение.

Величина тайм-аута применяется ко всем последующим операциям чтения и всем унаследованным дескрипторам мэйлслота.

Возвращаемые значения

В случае успеха возвращается ненулевое значение.

В случае неудачи возвращается нуль. Для получения дополнительной информации об ошибке вызовите функцию GetLastError .

Комментарии

Начальное значение тайм-аута, используемое мэйлслотом для операции чтения, обычно устанавливается в функции CreateMailslot при создании мэйлслота.

См. также

CreateMailslot, GetMailslotInfo .

SetMenuContextHelpId

Функция SetMenuContextHelpId связывает идентификатор контекстной справки с меню. Все пункты меню разделяют этот идентификатор. Нет возможности назначить идентификатор контекстной справки индивидуальному пункту меню.

BOOL SetMenuContextHelpId (

HMENU hmenu ,

DWORD dwContextHelpId

);

Параметры

hmenu - дескриптор меню, с которым связывается идентификатор контекстной справки.

dwContextHelpId - идентификатор контекстной справки.

Возвращаемые значения

В случае успеха возвращается ненулевое значение.

В случае неудачи возвращается нуль.

См. также

GetMenuContextHelpId .

KillTimer

Функция KillTimer разрушает указанный таймер.

BOOL KillTimer (

HWND hWnd , // дескриптор окна, установившего таймер

UINT uIDEvent // идентификатор таймера

);

Параметры

hWnd - идентифицирует окно, связанное с указанным таймером. Значение должно совпадать со значением параметра hWnd , переданным функции SetTimer , создавшей таймер.

uIDEvent - указывает таймер, который должен быть разрушен. Если дескриптор окна, переданный в функцию SetTimer , не равен NULL, то значение uIDEvent при вызове KillTimer должно совпадать со значением uIDEvent , переданного в SetTimer . Если приложение вызывало SetTimer с hWnd , установленным в NULL, то значение этого параметра должно быть идентификатором таймера, возвращенным SetTimer .

Возвращаемые значения

В случае успеха возвращается ненулевое значение.

В случае неудачи возвращается нуль. Для получения дополнительной информации об ошибке вызовите функцию GetLastError .

Комментарии

Функция KillTimer не удаляет сообщения WM_TIMER, уже помещенные в очередь сообщений.

См. также

SetTimer , WM_TIMER.

QueryPerformanceCounter

Функция QueryPerformanceCounter извлекает текущее значение счетчика производительности, если таковой существует.

BOOL QueryPerformanceCounter (

LARGE_INTEGER *lpPerformanceCount // адрес текущего значения счетчика

);

Параметры

lpPerformanceCount - указывает на переменную, которую функция устанавливает в текущее значение счетчика. Если установленное аппаратное обеспечение не поддерживает счетчик производительности, этот параметр может быть установлен в нуль.

Возвращаемые значения

В случае, если установленное аппаратное обеспечение поддерживает счетчик производительности, возвращается ненулевое значение.

Если установленное аппаратное обеспечение не поддерживает счетчик производительности, возвращается нуль.

См. также

QueryPerformanceFrequency .

QueryPerformanceFrequency

Функция QueryPerformanceFrequency извлекает частоту счетчика производительности, если таковой существует.

BOOL QueryPerformanceFrequency (

LARGE_INTEGER *lpFrequency // адрес текущей частоты

);

Параметры

lpFrequency - указывает на переменную, значение которой, в отсчетах в секунду, функция устанавливает в текущую частоту счетчика производительности. Если установленное аппаратное обеспечение не поддерживает счетчик производительности, значение этого параметра может быть равно нулю.

Возвращаемые значения

В случае, если установленное аппаратное обеспечение поддерживает счетчик производительности, возвращается ненулевое значение.

В случае, если установленное аппаратное обеспечение не поддерживает счетчик производительности, возвращается нуль.

См. также

QueryPerformanceCounter.

SetTimer

Функция SetTimer создает таймер с указанным интервалом срабатывания.

UINT SetTimer (

HWND hWnd , // дескриптор окна для сообщений таймера

UINT nIDEvent , // идентификатор таймера

UINT uElapse , // интервал срабатывания таймера

TIMERPROC lpTimerFunc // адрес процедуры таймера

);

Параметры

hWnd - идентифицирует окно, связанное с таймером. Окном должен владеть вызывающий поток. Если значение этого параметра равно NULL, с таймером не связывается никакого окна и параметр nIDEvent игнорируется.

nIDEvent - определяет ненулевой идентификатор таймера. Если значение параметра hWnd равно NULL, этот параметр игнорируется.

uElapse - определяет интервал срабатывания в миллисекундах.

lpTimerFunc - указывает на функцию, уведомляемую об истечении заданного интервала. Для дополнительной информации смотрите описание функции TimerProc .

Если значение lpTimerFunc равно NULL, система отправляет сообщение WM_TIMER в очередь собщений приложения. Значение члена hwnd структуры сообщения типа MSG содержит значение параметра hWnd .

Возвращаемые значения

В случае успеха возвращается целочисленный идентификатор нового таймера. Приложение может передавать этот идентификатор в функцию KillTimer для разрушения таймера.

Если не удалось создать новый таймер, возвращается нуль.

Комментарии

Приложение может обрабатывать сообщение WM_TIMER в оконной процедуре приложения, с соответствующим включением в ее исходный код оператора case, либо указывая при создании таймера функцию обратного вызова TimerProc . Когда вы указываете функцию обратного вызова, функция DispatchMessage просто вызывает ее вместо оконной процедуры.

Значение параметра wParam сообщения WM_TIMER содержит значение параметра nIDEvent .

См. также

DispatchMessage, KillTimer, MSG, TimerProc , WM_TIMER.

TimerProc

Функция TimerProc является определяемой приложением функцией обратного вызова, которая обрабатывает сообщения WM_TIMER.

VOID CALLBACK TimerProc (

HWND hwnd , // дескриптор окна для сообщений таймера

UINT uMsg , // сообщение WM_TIMER

UINT idEvent , // идентификатор таймера

DWORD dwTime // текущее системное время

);

Параметры

hwnd - идентифицирует окно, связанное с таймером.

uMsg - определяет сообщение WM_TIMER.

idEvent - определяет идентификатор таймера.

dwTime - задает число миллисекунд, истекших с момента старта Windows. Это значение возвращается функцией GetTickCount .

Возвращаемые значения

Функция не возвращает значения.

Комментарии

TimerProc является "заполнителем" для имени определяемой приложением функции.

См. также

GetTickCount, KillTimer, SetTimer , WM_TIMER.

WM_TIMER

Сообщение WM_TIMER отправляется в очередь сообщений установившего таймер потока или соответствующей функции обратного вызова TimerProc по истечении интервала, заданного при установке таймера функцией SetTimer .

WM_TIMER

wTimerID = wParam ; // идентификатор таймера

tmprc = ( TIMERPROC *) lParam ; // адрес функции обратного вызова таймера

Параметры

wTimerID - значение wParam . Определяет идентификатор таймера.

tmprc - значение lParam . Указывает на определяемую приложением функцию обратного вызова, адрес которой был передан при установке таймера функцией SetTimer . Если значение параметра tmprc не равно NULL, Windows передает сообщение WM_TIMER указанной функции обратного вызова вместо помещения сообщения в очередь сообщений потока.

Возвращаемые значения

Приложение должно возвращать нуль, если оно обрабатывает это сообщение.

Комментарии

Функция DispatchMessage передает сообщение в очередь сообщений потока, когда в ней нет других сообщений.

См. также

DispatchMessage, SetTimer, TimerProc .

SetKeyboardState

Функция SetKeyboardState копирует массив из 256 байт состояний клавиш в таблицу состояния ввода с клавиатуры вызывающего потока. Это та же самая таблица, к которой имеют доступ функции GetKeyboardState и GetKeyState . Изменения, сделанные в этой таблице, не влияют на ввод с клавиатуры для других потоков.

BOOL SetKeyboardState (

LPBYTE lpKeyState // адрес массива с кодами виртуальных клавиш

);

Параметры

lpKeyState - указывает на 256-байтный массив, который содержит состояния клавиш клавиатуры.

Возвращаемые значения

В случае успеха возвращается ненулевое значение.

В случае неудачи возвращается нуль. Для получения дополнительной информации об ошибке вызовите функцию GetLastError .

Комментарии

Поскольку функция SetKeyboardState изменяет состояние ввода вызывающего потока, но не глобальное состояние ввода системы, приложение не может использовать SetKeyboardState для установки индикаторов NUM LOCK, CAPS LOCK или r SCROLL LOCK на клавиатуре.

См. также

GetAsyncKeyState, GetKeyboardState, GetKeyState, MapVirtualKey .

CombineRgn

Функция CombineRgn объединяет две области и сохраняет результат в третьей. Две области объединяются согласно указанному режиму объединения.

int CombineRgn (

HRGN hrgnDest , // дескриптор результирующей области

HRGN hrgnSrc 1 , // дескриптор исходной области

HRGN hrgnSrc 2 , // дескриптор исходной области

int fnCombineMode // режим объединения областей

);

Параметры

hrgnDest - идентифицирует новую область с размерами, определяемыми двумя исходными областями (область должна существовать до вызова функции CombineRgn ).

hrgnSrc 1 - идентифицирует первую из двух исходных областей.

hrgnSrc 2 - идентифицирует вторую из двух исходных областей.

fnCombineMode - определяет режим объединения двух областей. Может принимать одно из следующих значений:

Возвращаемые значения

Возвращаемое значение показывает сложность результирующей области и может принимать одно из следующих значений:

Комментарии

Области могут совпадать друг с другом. Например, значение параметра hrgnSrc 1 может быть равно значению параметра hrgnDest .

См. также

CreateEllipticRgn, CreateEllipticRgnIndirect, CreatePolygonRgn, CreatePolyPolygonRgn, CreateRectRgn, CreateRectRgnIndirect, CreateRoundRectRgn .

CreateEllipticRgn

Функция CreateEllipticRgn создает эллиптическую область.

HRGN CreateEllipticRgn (

int nLeftRect , // x -координата верхнего левого угла

// ограничивающего прямоугольника

int nTopRect , // y - координата верхнего левого угла

// ограничивающего прямоугольника

int nRightRect , // x -координата нижнего правого угла

// ограничивающего прямоугольника

int nBottomRect // y - координата нижнего правого угла

// ограничивающего прямоугольника

);

Параметры

nLeftRect - определяет x -координату верхнего левого угла прямоугольника, ограничивающего эллипс.

nTopRect - определяет y -координату верхнего левого угла прямоугольника, ограничивающего эллипс.

nRightRect - определяет x -координату нижнего правого угла прямоугольника, ограничивающего эллипс.

nBottomRect - определяет y -координату нижнего правого угла прямоугольника, ограничивающего эллипс.

Возвращаемые значения

В случае успеха возвращается дескриптор области.

В случае неудачи возвращается NULL .

Комментарии

Ограничивающий прямоугольник определяет размер, форму и ориентацию области. Длинные стороны прямоугольника определяют длину большой оси эллипса; короткие стороны определяют длину малой оси эллипса; центр прямоугольника определяет пересечение большой и малой осей.

Координаты ограничивающего прямоугольника задаются в логических единицах.

См. также

CreateEllipticRgnIndirect, DeleteObject, SelectObject .

CreateEllipticRgnIndirect

Функция CreateEllipticRgnIndirect создает эллиптическую область.

HRGN CreateEllipticRgnIndirect (

CONST RECT * lprc // указатель на структуру, определяющую

// ограничивающий прямоугольник

);

Параметры

lprc - указатель на структуру типа RECT , которая содержит координаты верхнего левого и нижнего правого углов ограничивающего эллипс прямоугольника.

Возвращаемые значения

В случае успеха возвращается дескриптор области.

В случае неудачи возвращается NULL .

Комментарии

Ограничивающий прямоугольник определяет размер, форму и ориентацию области. Длинные стороны прямоугольника определяют длину большой оси эллипса; короткие стороны определяют длину малой оси эллипса; центр прямоугольника определяет пересечение большой и малой осей.

Координаты ограничивающего прямоугольника задаются в логических единицах.

См . также

CreateEllipticRgn, DeleteObject, RECT, SelectObject .

CreatePolygonRgn

Функция CreatePolygonRgn создает многоугольную область.

HRGN CreatePolygonRgn (

CONST POINT * lppt , // указатель на массив точек

int cPoints , // число точек в массиве

int fnPolyFillMode // режим заполнения многоугольника

);

Параметры

lppt - указатель на массив структур типа POINT , которые определяют вершины многоугольника. Многоугольник полагается замкнутым. Каждая вершина может быть задана лишь один раз.

cPoints - определяет количество точек в массиве.

fnPolyFillMode - определяет режим заполнения, используемый для определения того, какие пиксели входят в область. Может принимать одно из следующих значений:

Для дополнительной информации об этих режимах смотрите описание функции SetPolyFillMode .

Возвращаемые значения

В случае успеха возвращается дескриптор области.

В случае неудачи возвращается NULL .

См. также

CreatePolyPolygonRgn, DeleteObject, POINT, SelectObject, SetPolyFillMode .

CreatePolyPolygonRgn

Функция CreatePolyPolygonRgn создает область, состоящую из нескольких прямоугольников. Прямоугольники могут перекрывать друг друга.

HRGN CreatePolyPolygonRgn (

CONST POINT * lppt , // указатель на массив точек

CONST INT * lpPolyCounts , // указатель на массив,

// содержащий количества вершин

int nCount , // количество целых в массиве количества вершин

int fnPolyFillMode // режим заполнения многоугольника

);

Параметры

lppt - указатель на массив структур типа POINT , которые определяют вершины многоугольников. Многоугольники задаются последовательно. Каждый многоугольник полагается замкнутым, и каждая вершина может быть задана лишь один раз.

lpPolyCounts - указывает на массив целых, каждое из которых задает количество точек в одном из многоугольников в массиве, на который указывает значение параметра lppt .

nCount - определяет общее количество целых значений в массиве, на который указывает значение параметра lpPolyCounts .

fnPolyFillMode - определяет режим заполнения, используемый для определения того, какие пиксели входят в область. Может принимать одно из следующих значений:

Для дополнительной информации об этих режимах смотрите описание функции SetPolyFillMode .

Возвращаемые значения

В случае успеха возвращается дескриптор области.

В случае неудачи возвращается NULL .

См. также

CreatePolygonRgn, DeleteObject, POINT, SelectObject, SetPolyFillMode .

CreateRectRgn

Функция CreateRectRgn создает прямоугольную область.

HRGN CreateRectRgn (

int nLeftRect , // x-координата верхнего левого угла области

int nTopRect , // y-координата верхнего левого угла области

int nRightRect , // x-координата правого нижнего угла области

int nBottomRect // y-координата правого нижнего угла области

);

Параметры

nLeftRect - определяет x-координату верхнего левого угла области.

nTopRect - определяет y -координату верхнего левого угла области.

nRightRect - определяет x-координату правого нижнего угла области.