通过

ResUtilPropertyListFromParameterBlock 函数 (resapi.h)

  • 项目

从属性表和参数块构造属性列表。

语法

DWORD ResUtilPropertyListFromParameterBlock(
  [in]            const PRESUTIL_PROPERTY_ITEM pPropertyTable,
  [out, optional] PVOID                        pOutPropertyList,
  [in, out]       LPDWORD                      pcbOutPropertyListSize,
  [in]            const LPBYTE                 pInParams,
  [out]           LPDWORD                      pcbBytesReturned,
  [out]           LPDWORD                      pcbRequired
);

参数

[in] pPropertyTable

指向属性表的指针，该属性表描述将包含在生成的属性列表中的属性。

[out, optional] pOutPropertyList

指向接收属性列表的输出缓冲区的指针。

[in, out] pcbOutPropertyListSize

指向输出缓冲区大小（以字节为单位）的指针。

[in] pInParams

指向存储属性值的参数块的指针。

[out] pcbBytesReturned

如果函数返回 ERROR_SUCCESS， 则ERROR_SUCCESS，则“ERROR_SUCCESS ”将指向 pOutPropertyList 指向的属性列表的实际字节大小。 如果函数不返回 ERROR_SUCCESS， 则ERROR_SUCCESS，则“ERROR_SUCCESS ”将指向零值。

[out] pcbRequired

如果函数返回 ERROR_MORE_DATA， 则ERROR_MORE_DATA，则“ERROR_MORE_DATA” 指向包含属性列表所需的字节大小。 如果函数不返回 ERROR_MORE_DATA， 则ERROR_MORE_DATA，则“ERROR_MORE_DATA ”将指向零值。

返回值

如果操作成功，函数将返回 ERROR_SUCCESS。

如果操作失败，函数将返回 系统错误代码。 下面是可能的错误代码。

返回代码 说明
ERROR_MORE_DATA
 输出缓冲区太小，无法包含生成的属性列表。
ERROR_BAD_ARGUMENTS
 一个或多个输入参数无效。
ERROR_NOT_ENOUGH_MEMORY
 分配内存时出错。

注解

在此函数中，属性表确定属性在属性列表中的显示顺序，以及每个属性的名称和格式。 函数读取属性表以确定每个属性的名称和格式。

参数块提供属性值。

示例

以下示例定义了三个属性， (Protocol、PortNumber 和 ConnectionName) 。 它使用 ResUtilPropertyListFromParameterBlock 函数创建属性列表。 此示例使用故障转移群集文档中定义的 ClusDocEx.h 头文件。

//////////////////////////////////////////////////////////////////////

//  Be sure to create the following file before you compile.
//  For a code listing, see "ClusDocEx.h".
    #include "ClusDocEx.h"

//////////////////////////////////////////////////////////////////////

//  This example defines three fictional properties: 
//      Protocol (DWORD)
//      PortNumber (DWORD)
//      ConnectionName (PWSTR)
//  These properties are not associated with any cluster object.
//  They are used only to demonstrate the
//  ResUtilPropertyListFromParameterBlock function.

//  Protocol property constants
    #define PROP_NAME__PROTOCOL       L"Protocol"
    typedef enum PROTOCOLS{
        PROTOCOL_NONE = 0,
        PROTOCOL_BOTH = 1,
        PROTOCOL_TCP  = 2,
        PROTOCOL_UDP  = 3
    };
    #define PROP_MIN__PROTOCOL       (PROTOCOL_NONE)
    #define PROP_MAX__PROTOCOL       (PROTOCOL_UDP)
    #define PROP_DEFAULT__PROTOCOL   (PROTOCOL_BOTH)

//  PortNumber property
    #define PROP_NAME__PORTNUMBER     L"PortNumber"
    #define PROP_MIN__PORTNUMBER      (0)
    #define PROP_MAX__PORTNUMBER      (65536)
    #define PROP_DEFAULT__PORTNUMBER  (80)

//  ConnectionName property
    #define PROP_NAME__CONNECTIONNAME L"ConnectionName"

//  Parameter block
    typedef struct _PARAMBLOCK{
        DWORD dwProtocol;
        DWORD dwPortNumber;
        PWSTR pszConnectionName;
    } PARAMBLOCK; 
    
//  Property table
    RESUTIL_PROPERTY_ITEM
    pPropTable[] =
    {
        {   PROP_NAME__PROTOCOL, 
            NULL, 
            CLUSPROP_FORMAT_DWORD, 
            PROP_DEFAULT__PROTOCOL, 
            PROP_MIN__PROTOCOL, 
            PROP_MAX__PROTOCOL, 
            RESUTIL_PROPITEM_REQUIRED,  
            FIELD_OFFSET( _PARAMBLOCK, dwProtocol )        },

        {   PROP_NAME__PORTNUMBER,
            NULL, 
            CLUSPROP_FORMAT_DWORD, 
            PROP_DEFAULT__PORTNUMBER, 
            PROP_MIN__PORTNUMBER, 
            PROP_MAX__PORTNUMBER, 
            RESUTIL_PROPITEM_REQUIRED, 
            FIELD_OFFSET( _PARAMBLOCK, dwPortNumber )      },

        {   PROP_NAME__CONNECTIONNAME, 
            NULL, 
            CLUSPROP_FORMAT_SZ, 
                0, 0, 0, 0,
            FIELD_OFFSET( _PARAMBLOCK, pszConnectionName ) },

        { 0 }
    };

    int main()
    {
        DWORD nResult    = ERROR_SUCCESS,
              cbBufSize  = 1024,
              cbReturned = 0,
              cbRequired = 0;

        PVOID pPropList = LocalAlloc( LPTR, cbBufSize );

    //  Values for the property list
        PARAMBLOCK NewParams = { PROTOCOL_TCP, 21, L"FTP" };

        nResult = ResUtilPropertyListFromParameterBlock(
                      pPropTable,
                      pPropList,
                      &cbBufSize,
                      (LPBYTE) &NewParams,
                      &cbReturned,
                      &cbRequired );

        if( nResult == ERROR_MORE_DATA )
        {
            LocalFree( pPropList );

            cbBufSize = cbRequired;
            
            pPropList = LocalAlloc( LPTR, cbBufSize );

            nResult = ResUtilPropertyListFromParameterBlock(
                          pPropTable,
                          pPropList,
                          &cbBufSize,
                          (PBYTE) &NewParams,
                          &cbReturned,
                          &cbRequired );
        }

        ClusDocEx_DebugPrint( L"Results:", nResult );

        if( nResult == ERROR_SUCCESS )
            ClusDocEx_ShowBuffer( pPropList, cbReturned );    
    
        LocalFree( pPropList );
    
        return (int)( nResult != ERROR_SUCCESS );    
    }

要求

要求 值
最低受支持的客户端 无受支持的版本
最低受支持的服务器 Windows Server 2008 企业版、Windows Server 2008 Datacenter
目标平台 Windows
标头 resapi.h
Library ResUtils.lib
DLL ResUtils.dll

另请参阅

RESUTIL_PROPERTY_ITEM