---
title: "ksSheetSetupDlg - Открыть диалог для задания формата листа"
type: guide
api: [api7]
tags: [guide, api7, kssheetsetupdlg]
sources:
  - kssheetsetupdlg.html
---

*API экспортных функций > Функции работы с документами  > Общие функции *


## ksSheetSetupDlg - Открыть диалог для задания формата листа

Пример...
Синтаксис:
```
int ksSheetSetupDlg (DocumentParam* docPar, void *HWindow);
Входные параметры:
docPar    - указатель на структуру параметров документа,
Hwindow    - дескриптор окна.
Возвращаемое значение:
1    - в случае успешного завершения,
0    - при выходе из диалога по отмене.
```
Примечание:
1. Параметры docPar могут быть только параметрами чертежа, для любого другого типа документа функция ничего не сделает. Перед использованием функции необходимо правильно проинициализировать структуру docPar.
2. При использовании Unicode следует использовать функцию ksSheetSetupDlgW.


## ksSheetSetupDlg - пример использования

DocumentParam par;
par.type = lt_DocSheetStandart;
par.sheet.stPar.format = 4;
par.sheet.stPar.multiply = 1;
par.sheet.stPar.direct = 0;
if ( ::ksSheetSetupDlg(&par, ::GetHWindow()) ) {
char buf[256];
if ( par.type == lt_DocSheetStandart ) {
::sprintf( buf, "Стандартный лист : формат A%d, кратность %d, расположение %s", par.sheet.stPar.format,
par.sheet.stPar.multiply, par.sheet.stPar.direct ? "горизонтально" : "вертикально" );
}
else {
::sprintf( buf, "Пользовательский формат : Длина %g, Высота %g", par.sheet.usPar.width,
par.sheet.usPar.height );
}
::Message( buf );
}
