rmamon.pas

Delphi源码REAlRMSDK.rar

     *  Method:
     *      IRMAPNRegistry::SetIntByName
     *  Purpose:
     *      Modify a Property's INTEGER value in the registry given the
     *  Property's name "pName". If the value was set, it will return PNR_OK,
     *  otherwise it returns PNR_FAIL.
     *
     *  pName - IN - name of the Property whose value is to be set
     *  nValue - IN - the new value of the Property which is going to be set
     *)

    function SetIntByName(pName: PChar; nValue: INT32): HRESULT; stdcall;

    (************************************************************************
     *  Method:
     *      IRMAPNRegistry::SetIntById
     *  Purpose:
     *      Modify a Property's INTEGER value in the registry given the
     *  its id "id". If the value was set, it will return PNR_OK, otherwise
     *  it returns PNR_FAIL.
     *
     *  ulId - IN - unique id of the Property whose value is to be set
     *  nValue - IN - the new value of the Property which is going to be set
     *)

    function SetIntById(id: UINT32; nValue: INT32): HRESULT; stdcall;

    (************************************************************************
     *  Method:
     *      IRMAPNRegistry::AddStr
     *  Purpose:
     *      Add an STRING property with name in "pName" and value in
     *  "pValue" to the registry.
     *
     *  pName - IN - name of the Property that is going to be added to
     *               the registry
     *  pValue - IN - buffer value of the Property that is going to be
     *                added to the registry
     *)

    function AddStr(pName: PChar; pValue: IRMABuffer): UINT32; stdcall;

    (************************************************************************
     *  Method:
     *      IRMAPNRegistry::GetStrByName
     *  Purpose:
     *      Retreive an STRING value from the registry given its Property
     *  name "pName". If the Property is found, it will return PNR_OK,
     *  otherwise it returns PNR_FAIL.
     *
     *  pName - IN - name of the Property whose value is to be retreived
     *  pValue - OUT - parameter into which the value of the Property is
     *                 going to be returned
     *)

    function GetStrByName(pName: PChar; out pValue: IRMABuffer): HRESULT; stdcall;

    (************************************************************************
     *  Method:
     *      IRMAPNRegistry::GetStrById
     *  Purpose:
     *      Retreive an STRING value from the registry given its id "ulId".
     *  If the Property is found, it will return PNR_OK, otherwise it
     *  returns PNR_FAIL.
     *
     *  ulId - IN - unique id of the Property whose value is to be retreived
     *  pValue - OUT - parameter into which the value of the Property is
     *                 going to be returned
     *)

    function GetStrById(ulId: UINT32; out pValue: IRMABuffer): HRESULT; stdcall;

    (************************************************************************
     *  Method:
     *      IRMAPNRegistry::SetStrByName
     *  Purpose:
     *      Modify a Property's STRING value in the registry given the
     *  Property's name "pName". If the value was set, it will return
     *  PNR_OK, otherwise it returns PNR_FAIL.
     *
     *  pName - IN - name of the Property whose value is to be set
     *  pValue - IN - the new value of the Property which is going to be set
     *)

    function SetStrByName(pName: PChar; pValue: IRMABuffer): HRESULT; stdcall;

    (************************************************************************
     *  Method:
     *      IRMAPNRegistry::SetStrById
     *  Purpose:
     *      Modify a Property's STRING value in the registry given the
     *  its id "ulId". If the value was set, it will return PNR_OK,
     *  otherwise it returns PNR_FAIL.
     *
     *  ulId - IN - unique id of the Property whose value is to be set
     *  pValue - IN - the new value of the Property which is going to be set
     *)

    function SetStrById(ulId: UINT32; pValue: IRMABuffer): HRESULT; stdcall;

    (************************************************************************
     *  Method:
     *      IRMAPNRegistry::AddBuf
     *  Purpose:
     *      Add an BUFFER property with name in "pName" and value in
     *  "pValue" to the registry.
     *
     *  pName - IN - name of the Property that is going to be added to
     *               the registry
     *  pValue - IN - buffer value of the Property that is going to be
     *                added to the registry
     *)

    function AddBuf(pName: PChar; pValue: IRMABuffer): UINT32; stdcall;

    (************************************************************************
     *  Method:
     *      IRMAPNRegistry::GetBufByName
     *  Purpose:
     *      Retreive the BUFFER from the registry given its Property name
     *  "pName". If the Property is found, it will return PNR_OK, otherwise
     *  it returns PNR_FAIL.
     *
     *  pName - IN - name of the Property whose value is to be retreived
     *  pValue - OUT - parameter into which the value of the Property is
     *                 going to be returned
     *)

    function GetBufByName(pName: PChar; out pValue: IRMABuffer): HRESULT; stdcall;

    (************************************************************************
     *  Method:
     *      IRMAPNRegistry::GetBufById
     *  Purpose:
     *      Retreive the BUFFER from the registry given its id "ulId". If the
     *  Property is found, it will return PNR_OK, otherwise it returns
     *  PNR_FAIL.
     *
     *  ulId - IN - unique id of the Property whose value is to be retreived
     *  pValue - OUT - parameter into which the value of the Property is
     *                 going to be returned
     *)

    function GetBufById(ulId: UINT32;out pValue: IRMABuffer): HRESULT; stdcall;

    (************************************************************************
     *  Method:
     *      IRMAPNRegistry::SetBufByName
     *  Purpose:
     *      Modify a Property's BUFFER in the registry given the
     *  Property's name "pName". If the value was set, it will return
     *  PNR_OK, otherwise it returns PNR_FAIL.
     *
     *  pName - IN - name of the Property whose value is to be set
     *  pValue - IN - the new value of the Property which is going to be set
     *)

    function SetBufByName(pName: PChar; pValue: IRMABuffer): HRESULT; stdcall;

    (************************************************************************
     *  Method:
     *      IRMAPNRegistry::SetBufById
     *  Purpose:
     *      Modify a Property's BUFFER in the registry given its id "ulId".
     *  If the value was set, it will return PNR_OK, otherwise it returns
     *  PNR_FAIL.
     *
     *  ulId - IN - unique id of the Property whose value is to be set
     *  pValue - IN - the new value of the Property which is going to be set
     *)

    function SetBufById(ulId: UINT32; pValue: IRMABuffer): HRESULT; stdcall;

    (************************************************************************
     *  Method:
     *      IRMAPNRegistry::AddIntRef
     *  Purpose:
     *      Add an INTEGER REFERENCE property with name in "pName" and
     *  value in "iValue" to the registry. This property allows the user
     *  to modify its contents directly, without having to go through the
     *  registry.
     *
     *  pName - IN - name of the Property that is going to be added to
     *               the registry
     *  pValue - IN - the pointer of the integer value is what gets stored
     *                in the registry as the Interger Reference Property's
     *                value
     *)

    function AddIntRef(pName: PChar; pValue: PINT32): UINT32; stdcall;

    (************************************************************************
     *  Method:
     *      IRMAPNRegistry::DeleteByName
     *  Purpose:
     *      Delete a Property from the registry using its name "pName".
     *
     *  pName - IN - name of the Property that is going to be deleted
     *)

    function DeleteByName(pName: PChar): UINT32; stdcall;

    (************************************************************************
     *  Method:
     *      IRMAPNRegistry::DeleteById
     *  Purpose:
     *      Delete a Property from the registry using its id "ulId".
     *
     *  ulId - IN - unique id of the Property that is going to be deleted
     *)

    function DeleteById(ulId: UINT32): UINT32; stdcall;

    (************************************************************************
     *  Method:
     *      IRMAPNRegistry::GetTypeByName
     *  Purpose:
     *      Returns the datatype of the Property given its name "pName".
     *
     *  pName - IN - name of the Property whose type is to be retreived
     *)

    function GetTypeByName(pName: PChar): RMAPropType; stdcall;

    (************************************************************************
     *  Method:
     *      IRMAPNRegistry::GetTypeById
     *  Purpose:
     *      Returns the datatype of the Property given its its id "ulId".
     *
     *  ulId - IN - unique id of the Property whose type is to be retreived
     *)

    function GetTypeById(ulId: UINT32): RMAPropType; stdcall;

    (************************************************************************
     *  Method:
     *      IRMAPNRegistry::FindParentIdByName
     *  Purpose:
     *      Returns the id value of the parent node of the Property whose
     *  name "pName" has been passed in. If it fails, a ZERO value is
     *  returned.
     *
     *  pName - IN - name of the Property whose parent's unique id is to be
     *               retreived
     *)

    function FindParentIdByName(pName: PChar): UINT32; stdcall;

    (************************************************************************
     *  Method:
     *      IRMAPNRegistry::FindParentIdById
     *  Purpose:
     *      Returns the id value of the parent node of the Property whose
     *  id "ulId" has been passed in. If it fails, a ZERO value is returned.
     *
     *  ulId - IN - unique id of the Property whose parent's id is to be
     *              retreived
     *)

    function FindParentIdById(ulId: UINT32): UINT32; stdcall;

    (************************************************************************
     *  Method:
     *      PNRegistry::GetPropName
     *  Purpose:
     *      Returns the Property name in the pName char buffer passed
     *  as a parameter, given the Property's id "ulId".
     *
     *  ulId - IN - unique id of the Property whose name is to be retreived
     *  pName - OUT - parameter into which the Property name is going to be
     *                returned
     *)

    function GetPropName(ulId: UINT32; out pName: IRMABuffer): HRESULT; stdcall;

    (************************************************************************
     *  Method:
     *      PNRegistry::GetId
     *  Purpose:
     *      Returns the Property's id given the Property name.
     *
     *  pName - IN - name of the Property whose unique id is to be
     *               retreived
     *)

    function GetId(pName: PChar): UINT32; stdcall;

    (************************************************************************
     *  Method:
     *      IRMAPNRegistry::GetPropListOfRoot
     *  Purpose:
     *      Returns an array of a Properties under the root level of the
     *  registry's hierarchy.
     *
     *  pValues - OUT - list of property name and unique id at the
     *                  highest level (root) in the registry
     *)

    function GetPropListOfRoot(out pValues: IRMAValues): HRESULT; stdcall;

    (************************************************************************
     *  Method:
     *      IRMAPNRegistry::GetPropListByName
     *  Purpose:
     *      Returns an array of Properties immediately under the one whose
     *  name is passed in "pName".
     *
     *  pName - IN - name of the Property whose child property list is to be
     *               retreived
     *  pValues - OUT - list of property name and unique id under the
     *                  Property whose name is in "pName"
     *)

    function GetPropListByName(pName: PChar; out pValues: IRMAValues): HRESULT; stdcall;

    (************************************************************************
     *  Method:
     *      IRMAPNRegistry::GetPropListById
     *  Purpose:
     *      Returns an array of Properties immediately under the one whose
     *  id is passed in "ulId".
     *