windows-nt/Source/XPSP1/NT/admin/dscmd/dsget/gettable.h

377 lines
8.1 KiB
C
Raw Permalink Normal View History

2020-09-26 03:20:57 -05:00
//+-------------------------------------------------------------------------
//
// Microsoft Windows
// Copyright (C) Microsoft Corporation, 1992 - 2000
//
// File: gettable.h
//
// Contents: Defines Enum for dsget.
//
// History: 16-Oct-2000 JeffJon Created
//
//--------------------------------------------------------------------------
#ifndef _GETTABLE_H_
#define _GETTABLE_H_
//forward declarations
struct _DSGET_ATTRTABLE_ENTRY;
struct _DSGetObjectTableEntry;
//+--------------------------------------------------------------------------
//
// Class: CDSGetDisplayInfo
//
// Purpose: Object for maintaining attribute values which will be displayed
//
// History: 23-Oct-2000 JeffJon Created
//
//---------------------------------------------------------------------------
class CDSGetDisplayInfo
{
public:
//
// Constructor
//
CDSGetDisplayInfo()
: m_pszAttributeDisplayName(NULL),
m_dwAttributeValueCount(0),
m_ppszAttributeStringValue(NULL),
m_dwAttributeValueSize(0)
{}
//
// Desctructor
//
~CDSGetDisplayInfo()
{
if (m_ppszAttributeStringValue)
{
delete[] m_ppszAttributeStringValue;
m_ppszAttributeStringValue = NULL;
}
}
//
// Public Accessors
//
void SetDisplayName(PCWSTR pszDisplayName) { m_pszAttributeDisplayName = pszDisplayName; }
PCWSTR GetDisplayName() { return m_pszAttributeDisplayName; }
PCWSTR GetValue(DWORD dwIdx)
{
if (dwIdx < m_dwAttributeValueCount)
{
return m_ppszAttributeStringValue[dwIdx];
}
return NULL;
}
HRESULT AddValue(PCWSTR pszValue);
DWORD GetValueCount() { return m_dwAttributeValueCount; }
private:
//
// The name of the attribute as it is to be displayed in the output
//
PCWSTR m_pszAttributeDisplayName;
//
// The number of values in ppszAttributeStringValueArray
//
DWORD m_dwAttributeValueCount;
//
// The string value as it is to be displayed in the output
//
PWSTR* m_ppszAttributeStringValue;
//
// The size of the attribute array
//
DWORD m_dwAttributeValueSize;
};
typedef CDSGetDisplayInfo* PDSGET_DISPLAY_INFO;
//+-------------------------------------------------------------------------
//
// Type: PGETDISPLAYSTRINGFUNC
//
// Synopsis: The definition of a function that prepares ldapFilter from
// the infix filter given on the commandline.
//
//
// Returns: S_OK if the pAttr members were successfully set.
// S_FALSE if the function failed but displayed its own error message.
//
// History: 25-Sep-2000 hiteshr Created
//
//---------------------------------------------------------------------------
typedef HRESULT (*PGETDISPLAYSTRINGFUNC)(PCWSTR pszDN,
CDSCmdBasePathsInfo& refBasePathsInfo,
const CDSCmdCredentialObject& refCredentialObject,
_DSGetObjectTableEntry* pEntry,
ARG_RECORD* pRecord,
PADS_ATTR_INFO pAttrInfo,
CComPtr<IDirectoryObject>& spDirObject,
PDSGET_DISPLAY_INFO pDisplayInfo);
//+--------------------------------------------------------------------------
//
// Struct: _DSGET_ATTRTABLE_ENTRY
//
// Purpose: Definition of a table entry that describes the attribute for
// which filter can be specified at commandline.
//
// History: 25-Sep-2000 hiteshr Created
//
//---------------------------------------------------------------------------
typedef struct _DSGET_ATTRTABLE_ENTRY
{
//
// The name that will be used for display (ie "Account disabled" instead of
// "userAccountControl")
//
PCWSTR pszDisplayName;
//
// The ldapDisplayName of the attribute
//
PWSTR pszName;
//
// The unique identifier for this attribute that cooresponds to
// the command line switch
//
UINT nAttributeID;
//
// function that gets the string to display for
// the value
//
PGETDISPLAYSTRINGFUNC pDisplayStringFunc;
} DSGET_ATTR_TABLE_ENTRY, *PDSGET_ATTR_TABLE_ENTRY;
//+--------------------------------------------------------------------------
//
// Struct: _DSGetObjectTableEntry
//
// Purpose: Definition of a table entry that describes attributes of a given
// objecttype
//
// History: 25-Sep-2000 hiteshr Created
//
//---------------------------------------------------------------------------
typedef struct _DSGetObjectTableEntry
{
//
// The objectClass of the object to be created or modified
//
PCWSTR pszObjectClass;
//
// The command line string used to determine the object class
// This is not always identical to pszObjectClass
//
PCWSTR pszCommandLineObjectType;
//
// The table to merge with the common switches for the parser
//
ARG_RECORD* pParserTable;
//
// The ID of the Usage help text for this
//
UINT nUsageID;
//
// A count of the number of attributes in the table below
//
DWORD dwAttributeCount;
//
// A table of attributes for
// which filter can be specified at commandline.
//
DSGET_ATTR_TABLE_ENTRY** pAttributeTable;
} DSGetObjectTableEntry, *PDSGetObjectTableEntry;
typedef enum COMMON_COMMAND
{
//
// Common switches
//
#ifdef DBG
eCommDebug,
#endif
eCommHelp,
eCommObjectType,
eCommServer,
eCommDomain,
eCommUserName,
eCommPassword,
eCommContinue,
eCommQuiet,
eCommList,
eCommObjectDNorName,
eCommDN,
eCommDescription,
eTerminator,
//
// User switches
//
eUserSamID = eTerminator,
eUserSID,
eUserUpn,
eUserFn,
eUserMi,
eUserLn,
eUserDisplay,
eUserEmpID,
eUserOffice,
eUserTel,
eUserEmail,
eUserHometel,
eUserPager,
eUserMobile,
eUserFax,
eUserIPTel,
eUserWebPage,
eUserTitle,
eUserDept,
eUserCompany,
eUserManager,
eUserHomeDirectory,
eUserHomeDrive,
eUserProfilePath,
eUserLogonScript,
eUserMustchpwd,
eUserCanchpwd,
eUserPwdneverexpires,
eUserDisabled,
eUserAcctExpires,
eUserReversiblePwd,
eUserMemberOf,
eUserExpand,
eUserLast = eUserExpand,
//
// Contact switches
//
eContactFn = eTerminator,
eContactMi,
eContactLn,
eContactDisplay,
eContactOffice,
eContactTel,
eContactEmail,
eContactHometel,
eContactPager,
eContactMobile,
eContactFax,
eContactTitle,
eContactDept,
eContactCompany,
eContactLast = eContactCompany,
//
// Computer switches
//
eComputerSamID = eTerminator,
eComputerSID,
eComputerLoc,
eComputerDisabled,
eComputerMemberOf,
eComputerExpand,
eComputerLast = eComputerExpand,
//
// Group switches
//
eGroupSamname = eTerminator,
eGroupSID,
eGroupSecgrp,
eGroupScope,
eGroupMemberOf,
eGroupMembers,
eGroupExpand,
eGroupLast = eGroupExpand,
//
// OU doesn't have any additional switches
//
//
// Server switches
//
eServerDnsName = eTerminator,
eServerSite,
eServerIsGC,
eServerLast = eServerIsGC,
//
// Site switches
//
eSiteAutoTop = eTerminator,
eSiteCacheGroups ,
eSitePrefGC,
eSiteLast = eSitePrefGC,
//
// Subnet switches
//
eSubnetLocation = eTerminator,
eSubnetSite,
eSubnetLast = eSubnetSite,
/*
//
// Site Link switches
//
eSLinkIp = eTerminator,
eSLinkSmtp,
eSLinkAddsite,
eSLinkRmsite,
eSLinkCost,
eSLinkRepint,
eSLinkAutobacksync,
eSLinkNotify,
//
// Site Link Bridge switches
//
eSLinkBrIp = eTerminator,
eSLinkBrSmtp,
eSLinkBrAddslink,
eSLinkBrRmslink,
//
// Replication Connection switches
//
eConnTransport = eTerminator,
eConnEnabled,
eConnManual,
eConnAutobacksync,
eConnNotify,
*/
};
//
// The parser table
//
extern ARG_RECORD DSGET_COMMON_COMMANDS[];
//
// The table of supported objects
//
extern PDSGetObjectTableEntry g_DSObjectTable[];
#endif //_QUERYTABLE_H_