ksSetMacroParam - Записать параметры макроэлемента |
Scroll |
Аналог данной функции при использовании Automation - метод ksDocument2D::ksSetMacroParam.
Синтаксис:
int ksSetMacroParam( reference m,
void * value,
unsigned int size,
char * fileName,
char * libName,
int number,
unsigned char paramType );
Входные параметры:
m |
- указатель на макроэлемент, |
value |
- указатель на область памяти размером size, содержащую пользовательские данные для макроэлемента (см. описание ниже), |
size |
- размер области памяти с пользовательскими данными для макроэлемента; |
fileName |
- имя файла библиотеки; |
libName |
- имя библиотеки; |
number |
- номер функции в библиотеке, |
- битовый флаг, указание какой тип редактирования поддерживает макроэлемент. |
Возвращаемое значение:
1 |
- в случае успешного завершения, |
0 |
- в случае неудачи. |
Описание:
Запись в макроэлемент параметров, создающей его библиотечной функции, для дальнейшего редактирования. Если в сеансе работы системы КОМПАС-ГРАФИК такой макроэлемент указывается двойным щелчком левой кнопки мыши, то автоматически будет вызвана библиотечная функция для его редактирования. Она не обязательно должна совпадать с родительской функцией.
При значении имен библиотеки и ее файла NULL и номера функции -1 редактирование будет осуществляться родительской функцией.
При обработке событий это правило не действует, и в макроэлемент прописываются имя той библиотеки и ее файла, которая была использована непосредственно перед этим событием. Поэтому при создании макроэлемента по событию необходимо явно задавать имя библиотеки, имя файла и номер функции.
При необходимости в параметрах макроэлемента можно дополнительно сохранить пользовательские данные (допустимы все типы данных, кроме указателей), задав указатель на область памяти, в которой эти данные хранятся и размер этой области памяти (параметры value и size).
Примечание.
1. При использовании Unicode следует использовать функцию ksSetMacroParamW.
2. Параметры макроэлемента можно получить, используя функцию GetMacroParam.
Подразделы:
(отсутствуют)