Помогите с формулировкой

← →
Zlodey (2008-10-13 12:12) [0]

Помогите грамотно сформулировать описание для функции.
Вот что я написал:

Функция FindByField

Определение

function FindByField(const FieldName, FieldValue: WideString): HResult;

Параметры

FieldName: WideString; Имя поля по которому будет происходить поиск.
FieldValue: WideString; Значение поля по которому будет происходить поиск.

Описание

Функция ищет товары, по имени поля указанном параметром FieldName, и его значению, указанному параметром FieldValue. Функция при успешном выполнении возвращает количество найденных товаров. При аварийном завершении возвращает код равный “-1”.

← →
Сергей М. © (2008-10-13 12:20) [1]

Ерунда какая-то ..

Это ведь safecall-метод ?

safecall-методы должны возвращать не какие-то там "количества" каких-то там "товаров", а значения, определенные в соответствии соглашением

const
{ HRESULT value definitions }
{ Codes $4000-$40ff are reserved for OLE }

{ Success codes }
S_OK = $00000000;
{$EXTERNALSYM S_OK}
S_FALSE = $00000001;
{$EXTERNALSYM S_FALSE}

NOERROR = 0;
{$EXTERNALSYM NOERROR}

← →
Правильный$Вася (2008-10-13 12:21) [2]

много пунктационных ошибок
в названии функции ни о каких товарах речи не идет
почему товар ищется не по имени/категории, а по полю? он что, в разных местах хранится?
ничегоне сказано о регистрозависимости

чем меньше универсальных названий, тем лучше

Помогите с формулировкой Найти похожие ветки