IObject::GetName: различия между версиями

Текущая версия на 00:52, 18 декабря 2017

Компоненты на верхнем уровне \ Подсистема управления \ IObject \ GetName

return_code_t PLATFORM_NATIVE_CALLING_CONVENTION GetName(_Out_opt_z_capcount_(pcbName) char* pName, _Inout_ size_type* pcbName) const noexcept;

Получение уникального идентифицирующего имени объекта модели.

Параметры

[out]	pName	Буфер, на выходе принимающий строковое выражение идентификатора объекта. Выходная строка завершается терминальным нулем. Если требуется получение требуемого размера буфера, данный указатель и входное значение параметра `pcbName` должны быть обнулены.
[in,out]	pcbName	Указатель, на входе задающий емкость буфера `pName`, в байтах, а на выходе принимающий длину возвращенной строки в байтах исключая терминальный ноль. Если указатель `pName` сброшен в ноль, входное значение `pcbName` также должно быть нулевым. В этом случае выходным значением `pcbName` будет являться требуемый размер буфера, в байтах, для хранения всей строки, включая терминальный ноль.

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

32-битовый целый код ошибки, который в случае успешного выполнения неотрицателен.

@@ Строка 1: / Строка 1: @@
 {{NavBar|{{Системная иерархия:IObject}} \ GetName}}
-{{function begin|const name_type& GetName() const;
+{{function begin|return_code_t PLATFORM_NATIVE_CALLING_CONVENTION GetName(_Out_opt_z_capcount_(pcbName) char* pName, _Inout_ size_type* pcbName) const noexcept;|{{IObject::GetName brief}}}}
-name_type& GetName();|{{IObject::GetName brief}}}}
+{{function paramlist begin}}
-{{function return_value|Ссылка на C++ строку с именем объекта. Вторая перегрузка позволяет изменить имя, однако при этом должно быть соблюдено требование к уникальности имени в пространстве объектов модели.}}
+{{function paramlist add|pName|Буфер, на выходе принимающий строковое выражение идентификатора объекта. Выходная строка завершается терминальным нулем. Если требуется получение требуемого размера буфера, данный указатель и входное значение параметра <tt>pcbName</tt> должны быть обнулены.|paramdir=[out]}}
+{{function paramlist add|pcbName|Указатель, на входе задающий емкость буфера <tt>pName</tt>, в байтах, а на выходе принимающий длину возвращенной строки в байтах исключая терминальный ноль. Если указатель <tt>pName</tt> сброшен в ноль, входное значение <tt>pcbName</tt> также должно быть нулевым. В этом случае выходным значением <tt>pcbName</tt> будет являться требуемый размер буфера, в байтах, для хранения всей строки, включая терминальный ноль.|paramdir=[in,out]}}
+{{function paramlist end}}
+{{function_return_value|32-битовый целый код ошибки, который в случае успешного выполнения неотрицателен.}}
 {{function end}}

IObject::GetName: различия между версиями

Текущая версия на 00:52, 18 декабря 2017

Навигация

Поиск